An API managed within the APIIDA API Control Plane, representing a logical API resource that can be versioned and deployed to gateways.
Type: objectProperties: 8Required: 2
API GatewayAPI ManagementFederated API ManagementGovernanceLayer-7
APIIDA API is a JSON Structure definition published by APIIDA, describing 8 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "apiida-api-structure.json",
"description": "An API managed within the APIIDA API Control Plane, representing a logical API resource that can be versioned and deployed to gateways.",
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the API"
},
"name": {
"type": "string",
"description": "Display name of the API"
},
"description": {
"type": "string",
"description": "Human-readable description of the API"
},
"status": {
"type": "string",
"enum": [
"draft",
"published",
"deprecated",
"retired"
],
"description": "Current lifecycle status of the API"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags for categorizing the API"
},
"currentVersion": {
"type": "string",
"description": "The current active version identifier"
},
"createdAt": {
"type": "datetime",
"description": "Timestamp when the API was created"
},
"updatedAt": {
"type": "datetime",
"description": "Timestamp when the API was last updated"
}
},
"name": "APIIDA API"
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.