Akamai · Example Payload

Akamai Post Endpoints File Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Post Endpoints File 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

Raw ↑ 
{
  "operationId": "post-endpoints-file",
  "method": "POST",
  "path": "/endpoints/files",
  "summary": "Register an endpoint from an API definition file",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "contractId": "C-0N7RAC71",
        "groupId": 44681,
        "importFileContent": "ewogICJzd2FnZ2VyIjogIjIuMCIsCiAgImluZm8iOiB7CiAgICAidmVyc2lvbiI6ICIxLjAuMCIsCiAgICAidGl0bGUiOiAiQm9va3N0b3JlIEFQSSIsCiAgICAiZGVzY3JpcHRpb24iOiAiQW4gQVBJIGZvciBib29rc3RvcmUgdXNlcnMgYWxsb3dpbmcgdGhlbSB0byByZXRyaWV2ZSBib29rIGl0ZW1zLCBhZGQgbmV3IGl0ZW1zIChhZG1pbiB1c2VycyksIGFuZCBtb2RpZnkgZXhpc3RpbmcgaXRlbXMuIgogIH0sCiAgImhvc3QiOiAiYm9va3N0b3JlLmFwaS5ha2FtYWkuY29tIiwKICAic2NoZW1lcyI6IFsKICAgICJodHRwIiwKICAgICJodHRwcyIKICBdLAogICJzZWN1cml0eURlZmluaXRpb25zIjogewogICAgImFwaV9rZXkiOiB7CiAgICAgICJ0eXBlIjogImFwaUtleSIsCiAgICAgICJuYW1lIjogImFwaUtleSIsCiAgICAgICJpbiI6ICJoZWFkZXIiCiAgICB9CiAgfSwKICAiYmFzZVBhdGgiOiAiL2Jvb2tzdG9yZSIsCiAgInBhdGhzIjogewogICAgIi9ib29rcyI6IHsKICAgICAgImdldCI6IHsKICAgICAgICAiZGVzY3JpcHRpb24iOiAiTGlzdHMgYWxsIGJvb2sgaXRlbXMuIiwKICAgICAgICAib3BlcmF0aW9uSWQiOiAiZ2V0Qm9va3MiLAogICAgICAgICJwcm9kdWNlcyI6IFsKICAgICAgICAgICJhcHBsaWNhdGlvbi9qc29uIgogICAgICAgIF0sCiAgICAgICAgInJlc3BvbnNlcyI6IHsKICAgICAgICAgICIyMDAiOiB7CiAgICAgICAgICAgICJkZXNjcmlwdGlvbiI6ICJCb29rIHJlc3BvbnNlLiIsCiAgICAgICAgICAgICJzY2hlbWEiOiB7CiAgICAgICAgICAgICAgInR5cGUiOiAiYXJyYXkiLAogICAgICAgICAgICAgICJpdGVtcyI6IHsKICAgICAgICAgICAgICAgICIkcmVmIjogIiMvZGVmaW5pdGlvbnMvYm9vayIKICAgICAgICAgICAgICB9CiAgICAgICAgICAgIH0KICAgICAgICAgIH0KICAgICAgICB9CiAgICAgIH0sCiAgICAgICJwb3N0IjogewogICAgICAgICJkZXNjcmlwdGlvbiI6ICJDcmVhdGVzIGEgYm9vayBpdGVtIGluIHRoZSBib29rc3RvcmUuIiwKICAgICAgICAib3BlcmF0aW9uSWQiOiAicG9zdEJvb2siLAogICAgICAgICJwcm9kdWNlcyI6IFsKICAgICAgICAgICJhcHBsaWNhdGlvbi9qc29uIgogICAgICAgIF0sCiAgICAgICAgInBhcmFtZXRlcnMiOiBbewogICAgICAgICAgIm5hbWUiOiAiYm9vayIsCiAgICAgICAgICAiaW4iOiAiYm9keSIsCiAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiQSBib29rIHRvIGFkZCB0byB0aGUgYm9va3N0b3JlLiIsCiAgICAgICAgICAicmVxdWlyZWQiOiB0cnVlLAogICAgICAgICAgInNjaGVtYSI6IHsKICAgICAgICAgICAgIiRyZWYiOiAiIy9kZWZpbml0aW9ucy9uZXdCb29rIgogICAgICAgICAgfQogICAgICAgIH1dLAogICAgICAgICJyZXNwb25zZXMiOiB7CiAgICAgICAgICAiMjAwIjogewogICAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiQm9vayByZXNwb25zZS4iLAogICAgICAgICAgICAic2NoZW1hIjogewogICAgICAgICAgICAgICJ0eXBlIjogInN0cmluZyIsCiAgICAgICAgICAgICAgIiRyZWYiOiAiIy9kZWZpbml0aW9ucy9ib29rIgogICAgICAgICAgICB9CiAgICAgICAgICB9CiAgICAgICAgfQogICAgICB9CiAgICB9LAogICAgIi9ib29rcy97aWR9IjogewogICAgICAiZ2V0IjogewogICAgICAgICJkZXNjcmlwdGlvbiI6ICJSZXR1cm5zIGEgYm9vayBpdGVtLiIsCiAgICAgICAgIm9wZXJhdGlvbklkIjogImdldEJvb2siLAogICAgICAgICJwcm9kdWNlcyI6IFsKICAgICAgICAgICJhcHBsaWNhdGlvbi9qc29uIgogICAgICAgIF0sCiAgICAgICAgInBhcmFtZXRlcnMiOiBbewogICAgICAgICAgIm5hbWUiOiAiaWQiLAogICAgICAgICAgImluIjogInBhdGgiLAogICAgICAgICAgImRlc2NyaXB0aW9uIjogIkEgc3BlY2lmaWMgSUQgb2YgYSBib29rIGl0ZW0gdG8gcmV0dXJuLiIsCiAgICAgICAgICAicmVxdWlyZWQiOiB0cnVlLAogICAgICAgICAgInR5cGUiOiAiaW50ZWdlciIKICAgICAgICB9XSwKICAgICAgICAicmVzcG9uc2VzIjogewogICAgICAgICAgIjIwMCI6IHsKICAgICAgICAgICAgImRlc2NyaXB0aW9uIjogIkJvb2sgcmVzcG9uc2UuIiwKICAgICAgICAgICAgInNjaGVtYSI6IHsKICAgICAgICAgICAgICAidHlwZSI6ICJzdHJpbmciLAogICAgICAgICAgICAgICIkcmVmIjogIiMvZGVmaW5pdGlvbnMvYm9vayIKICAgICAgICAgICAgfQogICAgICAgICAgfQogICAgICAgIH0KICAgICAgfSwKICAgICAgImRlbGV0ZSI6IHsKICAgICAgICAiZGVzY3JpcHRpb24iOiAiRGVsZXRlcyBhIGJvb2sgaXRlbSBmcm9tIHRoZSBib29rc3RvcmUuIiwKICAgICAgICAib3BlcmF0aW9uSWQiOiAiZGVsZXRlQm9vayIsCiAgICAgICAgInByb2R1Y2VzIjogWwogICAgICAgICAgImFwcGxpY2F0aW9uL2pzb24iCiAgICAgICAgXSwKICAgICAgICAicGFyYW1ldGVycyI6IFt7CiAgICAgICAgICAibmFtZSI6ICJpZCIsCiAgICAgICAgICAiaW4iOiAicGF0aCIsCiAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiQSBzcGVjaWZpYyBJRCBvZiBhIGJvb2sgaXRlbSB0byBkZWxldGUuIiwKICAgICAgICAgICJyZXF1aXJlZCI6IHRydWUsCiAgICAgICAgICAidHlwZSI6ICJpbnRlZ2VyIgogICAgICAgIH1dLAogICAgICAgICJyZXNwb25zZXMiOiB7CiAgICAgICAgICAiMjA0IjogewogICAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiQm9vayBkZWxldGVkIgogICAgICAgICAgfQogICAgICAgIH0KICAgICAgfQogICAgfQogIH0KfQ==",
        "importFileFormat": "swagger",
        "importFileSource": "BODY_BASE64"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "201",
      "contentType": "application/json",
      "example": {
        "akamaiSecurityRestrictions": null,
        "apiEndPointId": 492375,
        "apiEndPointLocked": false,
        "apiEndPointName": "Bookstore API",
        "apiEndPointScheme": "http/https",
        "apiGatewayEnabled": true,
        "basePath": "/bookstore",
        "caseSensitive": true,
        "clonedFromVersion": 1,
        "consumeType": "any",
        "contractId": "C-0N7RAC7",
        "createDate": "2019-06-12T13:06:52+0000",
        "createdBy": "szhang",
        "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": 2,
        "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"
        ],
        "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": 2,
            "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,
                    "response": false,
                    "apiChildParameters": [],
                    "apiParameterRestriction": {
                      "arrayRestriction": null,
                      "numberRangeRestriction": null,
                      "rangeRestriction": null,
                      "xmlConversionRule": null,
                      "lengthRestriction": {
                        "lengthMax": 15,
                        "lengthMin": 3
                      }
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": {
        "apiEndpointDetails": {
          "akamaiSecurityRestrictions": null,
          "apiCategoryIds": null,
          "apiEndPointId": null,
          "apiEndPointLocked": null,
          "apiEndPointName": "Bookstore API",
          "apiEndPointScheme": "http/https",
          "apiProtectVersion": null,
          "basePath": "/bookstore",
          "clonedFromVersion": null,
          "consumeType": "any",
          "contractId": null,
          "createDate": null,
          "createdBy": null,
          "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.",
          "groupId": null,
          "lockVersion": -1,
          "productionStatus": null,
          "productionVersion": null,
          "protectedByApiKey": false,
          "securityScheme": null,
          "stagingStatus": null,
          "stagingVersion": null,
          "updateDate": null,
          "updatedBy": null,
          "versionNumber": null,
          "apiEndPointHosts": [
            "bookstore.api.akamai.com"
          ],
          "apiResources": []
        },
        "problems": [
          {
            "detail": "The object instance has properties which are not allowed by the schema: [\"unrecognizable\"]",
            "domain": "validation",
            "keyword": "additionalProperties",
            "level": "error",
            "pointer": "/paths/books/post",
            "title": "Invalid schema",
            "type": "/api-definitions/error-types/IMPORT-INVALID-SCHEMA"
          }
        ]
      }
    }
  ]
}