Akamai · Example Payload
Akamai Post Endpoints Example
CDNCloudEdge ComputingNetworksPlatformSecurity
Akamai Post Endpoints Example is an example object payload from Akamai, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "post-endpoints",
"method": "POST",
"path": "/endpoints",
"summary": "Register an endpoint",
"requestExamples": [
{
"contentType": "application/json",
"example": {
"apiEndPointName": "Bookstore API",
"apiEndPointScheme": "http/https",
"apiGatewayEnabled": true,
"basePath": "/bookstore",
"consumeType": "any",
"contractId": "C-0N7RAC71",
"description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.",
"groupId": 44681,
"isGraphQL": false,
"lockVersion": 0,
"apiCategoryIds": [
2,
7
],
"apiEndPointHosts": [
"bookstore.api.akamai.com"
],
"akamaiSecurityRestrictions": {
"MAX_BODY_SIZE": 61056,
"MAX_DOC_DEPTH": 64,
"MAX_ELEMENT_NAME_LENGTH": 256,
"MAX_INTEGER_VALUE": 9999,
"MAX_JSONXML_ELEMENT": 1032,
"MAX_STRING_LENGTH": 8192,
"POSITIVE_SECURITY_ENABLED": 1
},
"securityScheme": {
"securitySchemeType": "apikey",
"securitySchemeDetail": {
"apiKeyLocation": "header",
"apiKeyName": "apikey"
}
},
"apiResources": [
{
"apiResourceName": "books",
"description": "A book item within the bookstore API.",
"resourcePath": "/books/{bookId}",
"apiResourceMethods": [
{
"apiResourceMethod": "GET",
"apiParameters": [
{
"apiParameterLocation": "path",
"apiParameterName": "bookId",
"apiParameterNotes": null,
"apiParameterRequired": true,
"apiParameterRestriction": null,
"apiParameterType": "string",
"array": false,
"response": false
}
]
},
{
"apiResourceMethod": "POST",
"apiParameters": [
{
"apiParameterLocation": "path",
"apiParameterName": "bookId",
"apiParameterNotes": null,
"apiParameterRequired": true,
"apiParameterType": "string",
"array": false,
"response": false,
"apiParameterRestriction": {
"lengthRestriction": {
"lengthMax": 15,
"lengthMin": 3
}
}
}
]
}
]
}
]
}
}
],
"responseExamples": [
{
"status": "201",
"contentType": "application/json",
"example": {
"akamaiSecurityRestrictions": null,
"apiEndPointId": 492375,
"apiEndPointLocked": false,
"apiEndPointName": "Bookstore API",
"apiEndPointScheme": "http/https",
"apiEndPointVersion": 574127,
"apiGatewayEnabled": true,
"basePath": "/bookstore",
"caseSensitive": true,
"clonedFromVersion": null,
"consumeType": "any",
"contractId": "C-0N7RAC71",
"createDate": "2019-06-12T13:06:52+0000",
"createdBy": "jkowalski",
"description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.",
"endpointHidden": false,
"graphQL": false,
"groupId": 44681,
"isGraphQL": false,
"lockVersion": 0,
"positiveConstrainsEnabled": null,
"productionStatus": null,
"protectedByApiKey": true,
"responseConstraintsEnabled": false,
"source": null,
"stagingStatus": null,
"updateDate": "2019-06-12T13:06:52+0000",
"updatedBy": "bookstore_admin",
"versionHidden": false,
"versionNumber": 1,
"apiCategoryIds": [
2,
7
],
"apiEndPointHosts": [
"bookstore.api.akamai.com"
],
"availableActions": [
"DELETE",
"CLONE_ENDPOINT",
"ACTIVATE_ON_PRODUCTION",
"HIDE_ENDPOINT",
"EDIT_ENDPOINT_DEFINITION",
"ACTIVATE_ON_STAGING"
],
"discoveredPiiIds": [
455976
],
"productionVersion": {
"lastError": null,
"status": null,
"timestamp": null,
"versionNumber": null
},
"securityScheme": {
"securitySchemeType": "apikey",
"securitySchemeDetail": {
"apiKeyLocation": "header",
"apiKeyName": "apikey"
}
},
"stagingVersion": {
"lastError": null,
"status": null,
"timestamp": null,
"versionNumber": null
},
"apiResources": [
{
"apiResourceClonedFromId": null,
"apiResourceId": 2926712,
"apiResourceLogicId": 118435,
"apiResourceName": "books",
"createDate": "2019-06-12T13:06:52+0000",
"createdBy": "jperez",
"description": "A book item within the bookstore API.",
"link": null,
"lockVersion": 0,
"private": false,
"resourcePath": "/books/{bookId}",
"updateDate": "2019-06-12T13:06:52+0000",
"updatedBy": "bookstore_admin",
"apiResourceMethods": [
{
"apiResourceMethod": "GET",
"apiResourceMethodId": 341591,
"apiResourceMethodLogicId": 184404,
"apiParameters": [
{
"apiParamLogicId": 578116,
"apiParameterId": 1212945,
"apiParameterLocation": "path",
"apiParameterName": "bookId",
"apiParameterNotes": null,
"apiParameterRequired": true,
"apiParameterRestriction": null,
"apiParameterType": "string",
"apiResourceMethParamId": 494448,
"array": false,
"pathParamLocationId": null,
"response": false,
"apiChildParameters": []
}
]
},
{
"apiResourceMethod": "POST",
"apiResourceMethodId": 341592,
"apiResourceMethodLogicId": 184405,
"apiParameters": [
{
"apiParamLogicId": 578117,
"apiParameterId": 1212946,
"apiParameterLocation": "path",
"apiParameterName": "bookId",
"apiParameterNotes": null,
"apiParameterRequired": true,
"apiParameterType": "string",
"apiResourceMethParamId": 494449,
"array": false,
"pathParamLocationId": null,
"apiChildParameters": [],
"apiParameterRestriction": {
"apiParameterType": "json",
"array": true,
"numberRangeRestriction": null,
"rangeRestriction": null,
"response": true,
"xmlConversionRule": null,
"arrayRestriction": {
"maxItems": 200,
"minItems": 100
},
"responseRestriction": {
"maxBodySize": "SIZE_6K",
"statusCodes": [
200,
201
]
}
}
}
]
}
]
}
]
}
}
]
}