Akamai · Example Payload
Akamai Post Api Endpoint Resource Example
CDNCloudEdge ComputingNetworksPlatformSecurity
Akamai Post Api Endpoint Resource 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-api-endpoint-resource",
"method": "POST",
"path": "/api-discovery/host/{hostname}/basepath/{basePath}/endpoints",
"summary": "Create an endpoint or resource",
"requestExamples": [
{
"contentType": "application/json",
"example": {
"apiName": "New API",
"contractId": "C-0N7RAC71",
"groupId": 12345
}
}
],
"responseExamples": [
{
"status": "201",
"contentType": "application/json",
"example": {
"akamaiSecurityRestrictions": null,
"apiCategoryIds": [
2,
7
],
"apiEndPointHosts": [
"bookstore.api.akamai.com"
],
"apiEndPointId": 492375,
"apiEndPointLocked": false,
"apiEndPointName": "Bookstore API",
"apiEndPointScheme": "http/https",
"apiEndPointVersion": 574127,
"apiResources": [
{
"apiResourceClonedFromId": null,
"apiResourceId": 2926712,
"apiResourceLogicId": 118435,
"apiResourceMethods": [
{
"apiParameters": [
{
"apiChildParameters": [],
"apiParamLogicId": 578116,
"apiParameterId": 1212945,
"apiParameterLocation": "path",
"apiParameterName": "bookId",
"apiParameterNotes": null,
"apiParameterRequired": true,
"apiParameterRestriction": null,
"apiParameterType": "string",
"apiResourceMethParamId": 494448,
"array": false,
"pathParamLocationId": null,
"response": false
}
],
"apiResourceMethod": "GET",
"apiResourceMethodId": 341591,
"apiResourceMethodLogicId": 184404
},
{
"apiParameters": [
{
"apiChildParameters": [],
"apiParamLogicId": 578117,
"apiParameterId": 1212946,
"apiParameterLocation": "path",
"apiParameterName": "bookId",
"apiParameterNotes": null,
"apiParameterRequired": true,
"apiParameterRestriction": {
"arrayRestriction": null,
"lengthRestriction": {
"lengthMax": 15,
"lengthMin": 3
},
"numberRangeRestriction": null,
"rangeRestriction": null,
"xmlConversionRule": null
},
"apiParameterType": "string",
"apiResourceMethParamId": 494449,
"array": false,
"pathParamLocationId": null,
"response": false
}
],
"apiResourceMethod": "POST",
"apiResourceMethodId": 341592,
"apiResourceMethodLogicId": 184405
}
],
"apiResourceName": "books",
"createDate": "2019-06-12T13:06:52+0000",
"createdBy": "alfulani",
"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"
}
],
"availableActions": [
"DELETE",
"CLONE_ENDPOINT",
"ACTIVATE_ON_PRODUCTION",
"HIDE_ENDPOINT",
"EDIT_ENDPOINT_DEFINITION",
"ACTIVATE_ON_STAGING"
],
"basePath": "/bookstore",
"caseSensitive": true,
"clonedFromVersion": null,
"consumeType": "any",
"contractId": "C-0N7RAC71",
"createDate": "2019-06-12T13:06:52+0000",
"createdBy": "hgildong",
"description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.",
"endpointHidden": false,
"groupId": 12345,
"isGraphQL": false,
"lockVersion": 0,
"positiveConstrainsEnabled": null,
"productionStatus": null,
"productionVersion": {
"lastError": null,
"status": null,
"timestamp": null,
"versionNumber": null
},
"protectedByApiKey": true,
"securityScheme": {
"securitySchemeDetail": {
"apiKeyLocation": "header",
"apiKeyName": "apikey"
},
"securitySchemeType": "apikey"
},
"source": null,
"stagingStatus": null,
"stagingVersion": {
"lastError": null,
"status": null,
"timestamp": null,
"versionNumber": null
},
"updateDate": "2019-06-12T13:06:52+0000",
"updatedBy": "bookstore_admin",
"versionHidden": false,
"versionNumber": 1
}
},
{
"status": "400",
"contentType": "application/json",
"example": {
"detail": "The request could not be understood by the server due to malformed syntax.",
"instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
"status": 400,
"title": "Bad Request",
"type": "https://problems.luna.akamaiapis.net/appsec/error-types/BAD-REQUEST"
}
},
{
"status": "403",
"contentType": "application/problem+json",
"example": {
"detail": "You do not have the necessary access to perform this operation or the requested resource cannot be modified",
"instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
"status": 403,
"title": "Forbidden",
"type": "https://problems.luna.akamaiapis.net/appsec-resource/error-types/ACCESS-DENIED"
}
},
{
"status": "404",
"contentType": "application/problem+json",
"example": {
"detail": "The requested resource is not found",
"instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
"status": 404,
"title": "Not Found",
"type": "https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND"
}
},
{
"status": "500",
"contentType": "application/problem+json",
"example": {
"detail": "Internal Server Error",
"instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no",
"status": 500,
"title": "Internal Server Error",
"type": "internal_server_error"
}
}
]
}