Unkey · Schema

V2ApisGetApiRequestBody

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name	Type	Description
apiId	string	Specifies which API to retrieve by its unique identifier. Must be a valid API ID that begins with 'api_' and exists within your workspace.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2ApisGetApiRequestBody",
  "title": "V2ApisGetApiRequestBody",
  "type": "object",
  "required": [
    "apiId"
  ],
  "properties": {
    "apiId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 255,
      "pattern": "^[a-zA-Z0-9_]+$",
      "description": "Specifies which API to retrieve by its unique identifier.\nMust be a valid API ID that begins with 'api_' and exists within your workspace.\n",
      "example": "api_1234abcd"
    }
  },
  "additionalProperties": false
}