Set interaction restrictions for your public repositories

2 body fields

limitstringrequired

The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.

Allowed:existing_userscontributors_onlycollaborators_only

expirystringoptional

The duration of the interaction restriction. Default: `one_day`.

Allowed:one_daythree_daysone_weekone_monthsix_months

2 status codes

200Response

limitstringrequired

The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.

Allowed:existing_userscontributors_onlycollaborators_only

originstringrequired

expires_atstringrequired

422Validation failed, or the endpoint has been spammed.

messagestringrequired

documentation_urlstringrequired

errorsarray<object>optional

Error handling

A 422 is returned: Validation failed, or the endpoint has been spammed.

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.interactionLimits.update({
  limit: 20,
  expiry: "example",
});

{
  "limit": "collaborators_only",
  "origin": "user",
  "expires_at": "2018-08-17T04:18:39Z"
}

Was this helpful?

Request

Response

Errors