Skip to main content

APISettingsInput

API settings.

input APISettingsInput {
  allowedOrigins: String
  apiVersion: String
  enableAPI: Boolean
  enableWebhooks: Boolean
  rateLimitPerHour: String
  rateLimitPerMinute: String
  requireApiKeys: Boolean
  webhookRetryAttempts: String
}

Fields​

APISettingsInput.allowedOrigins ● String scalar​

The origins allowed to call the API, comma separated.

APISettingsInput.apiVersion ● String scalar​

The API version in use.

APISettingsInput.enableAPI ● Boolean scalar​

True to switch the API on.

APISettingsInput.enableWebhooks ● Boolean scalar​

True to switch webhooks on.

APISettingsInput.rateLimitPerHour ● String scalar​

The most requests allowed per hour.

APISettingsInput.rateLimitPerMinute ● String scalar​

The most requests allowed per minute.

APISettingsInput.requireApiKeys ● Boolean scalar​

True when requests must carry an API key.

APISettingsInput.webhookRetryAttempts ● String scalar​

How many times a failed webhook is retried.

Member Of​

updateAPISettings mutation