APIs.io Engineering Platform · Schema
ApiKey
A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| id | object | |
| value | object | |
| name | object | |
| customerId | object | |
| description | object | |
| enabled | object | |
| createdDate | object | |
| lastUpdatedDate | object | |
| stageKeys | object | |
| tags | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/ApiKey",
"title": "ApiKey",
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The identifier of the API Key."
}
]
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The value of the API Key."
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The name of the API Key."
}
]
},
"customerId": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace."
}
]
},
"description": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The description of the API Key."
}
]
},
"enabled": {
"allOf": [
{
"$ref": "#/components/schemas/Boolean"
},
{
"description": "Specifies whether the API Key can be used by callers."
}
]
},
"createdDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The timestamp when the API Key was created."
}
]
},
"lastUpdatedDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The timestamp when the API Key was last updated."
}
]
},
"stageKeys": {
"allOf": [
{
"$ref": "#/components/schemas/ListOfString"
},
{
"description": "A list of Stage resources that are associated with the ApiKey resource."
}
]
},
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/MapOfStringToString"
},
{
"description": "The collection of tags. Each tag element is associated with a given resource."
}
]
}
},
"description": "A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage."
}