Ampersand · JSON Structure

Ampersand Api Api Key Request Structure

ApiKeyRequest schema from Ampersand API

Type: object Properties: 2 Required: 1
Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

ApiKeyRequest is a JSON Structure definition published by Ampersand, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

label scopes

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-structure/ampersand-api-api-key-request-structure.json",
  "name": "ApiKeyRequest",
  "description": "ApiKeyRequest schema from Ampersand API",
  "type": "object",
  "properties": {
    "label": {
      "type": "string",
      "description": "A short name for the API key.",
      "example": "MailMonkey API Key"
    },
    "scopes": {
      "$ref": "#/components/schemas/ApiKeyScopes"
    }
  },
  "required": [
    "label"
  ]
}