APIs.io Engineering Platform · Schema
CreateApiKeyRequest
Request to create an ApiKey resource.
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| name | object | |
| description | object | |
| enabled | object | |
| generateDistinctId | object | |
| value | object | |
| stageKeys | object | |
| customerId | object | |
| tags | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/CreateApiKeyRequest",
"title": "CreateApiKeyRequest",
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The name of the ApiKey."
}
]
},
"description": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The description of the ApiKey."
}
]
},
"enabled": {
"allOf": [
{
"$ref": "#/components/schemas/Boolean"
},
{
"description": "Specifies whether the ApiKey can be used by callers."
}
]
},
"generateDistinctId": {
"allOf": [
{
"$ref": "#/components/schemas/Boolean"
},
{
"description": "Specifies whether (<code>true</code>) or not (<code>false</code>) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used."
}
]
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "Specifies a value of the API key."
}
]
},
"stageKeys": {
"allOf": [
{
"$ref": "#/components/schemas/ListOfStageKeys"
},
{
"description": "DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key."
}
]
},
"customerId": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace."
}
]
},
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/MapOfStringToString"
},
{
"description": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters."
}
]
}
},
"description": "Request to create an ApiKey resource."
}