API Endpoint Definition API Resources

The API Endpoint Definition API allows you to programmatically define an API endpoint and its set of component resources. This API allows you to define request body and resource constraints so that you can enforce them separately as a whitelist in a Kona Site Defender firewall policy. It also allows you to set Akamai API Gateway settings, such as JWT validation, CORS, caching, and GZIP compression.

The following summarizes the objects with which you interact:

  • An endpoint is a set of logically related API resources. See the Endpoint object.

  • A resource is a URL pattern that responds to HTTP method calls for each API operation. See the Resource object.

  • A version is the API version that you set up to make your endpoint, resource, and delivery configurations effective. You can activate an API version in the Akamai staging or production environment.

  • The delivery settings allow you to configure JWT validation, CORS, caching, and GZIP compression. Enabling these features can help you manage your your APIs more efficiently, improve interoperability, and enhance overall performance of your API traffic.

NOTE: In the table below and for all other APIs listed on the Akamai Developer site, responsive URL patterns are commonly referred to as endpoints, not as resources as in this API. Within this API, an endpoint refers to a logical collection of resources.

API Summary

Download the RAML descriptors for this API.

Operation Method Endpoint
Endpoints  
List Endpoints GET /api-definitions/v2/endpoints{?page,pageSize,category,contains,sortBy,sortOrder,versionPreference,contractId,groupId}
Create a New Version POST /api-definitions/v2/endpoints
Clone an Endpoint POST /api-definitions/v2/endpoints/cloneEndpoint
Create a New API Endpoint from a File Upload POST /api-definitions/v2/endpoints/translate
List User Entitlements GET /api-definitions/v2/endpoints/user-entitlements
Remove an Endpoint DELETE /api-definitions/v2/endpoints/{apiEndPointId}
List Versions GET /api-definitions/v2/endpoints/{apiEndPointId}/versions
Modify a Version PUT /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}
Remove a Version DELETE /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}
Get a Version GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/resources-detail
Clone a Version POST /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/cloneVersion
Activate a Version POST /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/activate
Deactivate a Version POST /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/deactivate
List Resources GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/resources
Create a New Resource POST /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/resources
Get a Resource GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/resources/{apiResourceId}
Modify a Resource PUT /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/resources/{apiResourceId}
Remove a Resource DELETE /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/resources/{apiResourceId}
Endpoint Settings  
Get Cache Settings GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/cache
Update Cache Settings PUT /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/cache
Get GZIP Settings GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/gzip
Update GZIP Settings PUT /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/gzip
Update CORS Settings GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/cors
Get CORS Settings PUT /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/cors
Get JWT Settings GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/jwt
Update JWT Settings PUT /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/jwt
Get API Privacy Settings GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/api-privacy
Update API Privacy Settings PUT /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/api-privacy

List Endpoints

Lists available API endpoints, with results optionally paginated, sorted, and filtered. If no APIs are available, the operation responds with an empty array.

GET /api-definitions/v2/endpoints{?page,pageSize,category,contains,sortBy,sortOrder,versionPreference,contractId,groupId}

Sample: /api-definitions/v2/endpoints?page=5&pageSize=50&category=Site%20Delivery&contains=cloud%20security&sortBy=updateDate&sortOrder=asc&versionPreference=ACTIVATED_FIRST&contractId=1-xc789&groupId=67890

Parameter Type Sample Description
Optional Query Parameters
category String Site Delivery Filters endpoints by the specified apiCategoryName, including the __UNCATEGORIZED__ keyword.
contains String cloud security Search query substring criteria matching the API’s name, description, basePath, apiCategoryName, and resourcePath.
contractId String 1-xc789 Filter to a specific contract. You need to specify this along with a groupId.
groupId Integer 67890 Filter to a specific group. You need to specify this along with a contractId.
page Integer 5 The page number index, starting at the default value of 1.
pageSize Integer 50 The number of API endpoints on each page of results. This is 25 by default.
sortBy Enumeration updateDate The field to sort by, either the API name (corresponding to the apiEndPointName member) or updateDate.
sortOrder Enumeration asc Sort order, either desc for descending or the default asc for ascending.
versionPreference Enumeration ACTIVATED_FIRST Preference for picking the endpoint version, either pick the production or staging activated version (ACTIVATED_FIRST) or the default last updated version (LAST_UPDATED).

Status 200 application/json

Response Body:

{
    "totalSize": 15,
    "pageSize": 2,
    "links": [
        {
            "href": "/api-definitions/v1/endpoints?pageSize=2&page=1",
            "rel": "self"
        },
        {
            "href": "/api-definitions/v1/endpoints?pageSize=2&page=2",
            "rel": "next"
        },
        {
            "href": "/api-definitions/v1/endpoints?pageSize=2&page=0",
            "rel": "previous"
        }
    ],
    "apiEndPoints": [
        {
            "apiEndPointName": "API Test",
            "apiEndPointScheme": "https",
            "apiEndPointLocked": false,
            "description": "The first version of API Test",
            "productionVersion": {
                "status": null,
                "versionNumber": null
            },
            "apiEndPointId": 81,
            "apiCategoryIds": [],
            "createDate": "2016-09-29T03:30:27+0000",
            "versionNumber": 1,
            "protectedByApiKey": false,
            "apiResourceBaseInfo": [
                {
                    "description": null,
                    "lockVersion": 0,
                    "apiResourceName": "/locations/{location-id}",
                    "resourcePath": "/locations/{location-id}",
                    "private": false,
                    "apiResourceLogicId": 43,
                    "link": null,
                    "updateDate": "2016-09-29T03:30:32+0000",
                    "createdBy": "kusingh",
                    "updatedBy": "kusingh",
                    "createDate": "2016-09-29T03:30:32+0000",
                    "apiResourceId": 43,
                    "apiResourceClonedFromId": null
                }
            ],
            "clonedFromVersion": null,
            "stagingVersion": {
                "status": null,
                "versionNumber": null
            },
            "updateDate": "2016-09-29T03:30:27+0000",
            "createdBy": "kusingh",
            "updatedBy": "kusingh",
            "apiEndPointHosts": [
                "rbac.edgesuite.net"
            ],
            "consumeType": "json",
            "apiEndPointVersion": 81,
            "groupId": 44681,
            "basePath": "/v1"
        }
    ],
    "page": 8
}

Create a New Version

Creates a new endpoint version with or without resources. This is version 1 of this endpoint. The endpoint’s name needs to be unique within the account.

POST /api-definitions/v2/endpoints

Content-Type: application/json

Request Body:

{
    "apiEndPointName": "API Test",
    "description": "API test description",
    "securityScheme": {
        "securitySchemeDetail": {
            "apiKeyLocation": "header",
            "apiKeyName": "header-101"
        },
        "securitySchemeType": "apikey"
    },
    "apiCategoryIds": [
        161
    ],
    "basePath": "/api/test/basepath",
    "akamaiSecurityRestrictions": {
        "MAX_DOC_DEPTH": 64,
        "MAX_JSONXML_ELEMENT": 1032,
        "MAX_BODY_SIZE": 61056,
        "MAX_INTEGER_VALUE": 9999,
        "MAX_STRING_LENGTH": 8192,
        "MAX_ELEMENT_NAME_LENGTH": 256,
        "POSITIVE_SECURITY_ENABLED": 1
    },
    "apiEndPointHosts": [
        "www.akamatest.com"
    ],
    "consumeType": "json/xml",
    "groupId": 44681,
    "contractId": "3-13H55B5"
}

Status 201 application/json

Headers:

Location: /api-definitions/v1/endpoints/123/versions/1

Response Body:

{
    "securityScheme": {
        "securitySchemeId": 4523,
        "securitySchemeDetail": {
            "apiKeyLocation": "header",
            "apiKeyName": "header-101"
        },
        "securitySchemeDescription": null,
        "securitySchemeType": "apikey"
    },
    "apiEndPointName": "API Test",
    "lockVersion": 0,
    "apiEndPointVersion": 326202,
    "stagingVersion": {
        "status": null,
        "versionNumber": null
    },
    "stagingStatus": null,
    "createDate": "2017-11-17T19:27:07+0000",
    "apiResources": [],
    "protectedByApiKey": false,
    "productionStatus": null,
    "apiEndPointId": 314252,
    "description": "API test description",
    "productionVersion": {
        "status": null,
        "versionNumber": null
    },
    "versionNumber": 1,
    "createdBy": "ccare2",
    "updatedBy": "ccare2",
    "groupId": 44681,
    "contractId": "3-13H55B5",
    "apiEndPointScheme": null,
    "apiEndPointLocked": false,
    "apiCategoryIds": [
        161
    ],
    "basePath": "/api/test/basepath",
    "akamaiSecurityRestrictions": {
        "MAX_DOC_DEPTH": 64,
        "MAX_JSONXML_ELEMENT": 1032,
        "MAX_BODY_SIZE": 61056,
        "MAX_INTEGER_VALUE": 9999,
        "MAX_STRING_LENGTH": 8192,
        "MAX_ELEMENT_NAME_LENGTH": 256,
        "POSITIVE_SECURITY_ENABLED": 1
    },
    "clonedFromVersion": null,
    "updateDate": "2017-11-17T19:27:07+0000",
    "apiEndPointHosts": [
        "www.akamatest.com"
    ],
    "consumeType": "json/xml"
}

Clone an Endpoint

Clone a new endpoint from the specified endpoint ID and version.

POST /api-definitions/v2/endpoints/cloneEndpoint

Content-Type: application/json

Request Body:

{
    "apiEndPointId": 313304,
    "apiEndPointName": "Clone Endpoint",
    "basePath": "/api-baseth",
    "apiEndPointVersionNumber": 1,
    "apiEndPointHosts": [
        "test-uvm-97-qa.com.edgesuite-staging.net"
    ],
    "groupId": 44680,
    "contractId": "3-13H55B5"
}

Status 200 application/json

Response Body:

{
    "securityScheme": {
        "securitySchemeId": 5083,
        "securitySchemeDetail": {
            "apiKeyLocation": "header",
            "apiKeyName": "header-api"
        },
        "securitySchemeDescription": null,
        "securitySchemeType": "apikey"
    },
    "apiEndPointName": "Test-api",
    "lockVersion": 0,
    "apiEndPointVersion": 320192,
    "stagingVersion": {
        "status": null,
        "versionNumber": null
    },
    "stagingStatus": null,
    "createDate": "2017-09-06T16:15:44+0000",
    "apiResources": [
        {
            "description": "res1-notes",
            "lockVersion": 0,
            "apiResourceName": "/resource-1",
            "apiResourceMethods": [
                {
                    "apiParameters": [
                        {
                            "clonedFromId": null,
                            "apiParameterRestriction": {
                                "lengthRestriction": null,
                                "rangeRestriction": {
                                    "rangeMax": null,
                                    "rangeMin": null
                                },
                                "xmlConversionRule": null,
                                "numberRangeRestriction": null,
                                "arrayRestriction": null
                            },
                            "apiParamLogicId": 32645,
                            "pathParamLocationId": 0,
                            "apiParameterRequired": true,
                            "apiParameterType": "integer",
                            "apiChildParameters": [],
                            "apiParameterId": 35545,
                            "apiParameterName": "param1",
                            "apiResourceMethParamId": 19682,
                            "array": false,
                            "apiParameterLocation": "header",
                            "apiParameterNotes": null
                        },
                        {
                            "clonedFromId": null,
                            "apiParameterRestriction": {
                                "lengthRestriction": null,
                                "rangeRestriction": null,
                                "xmlConversionRule": null,
                                "numberRangeRestriction": {
                                    "numberRangeMin": null,
                                    "numberRangeMax": 999999.0
                                },
                                "arrayRestriction": null
                            },
                            "apiParamLogicId": 32646,
                            "pathParamLocationId": 0,
                            "apiParameterRequired": false,
                            "apiParameterType": "number",
                            "apiChildParameters": [],
                            "apiParameterId": 35546,
                            "apiParameterName": "param-2",
                            "apiResourceMethParamId": 19683,
                            "array": false,
                            "apiParameterLocation": "cookie",
                            "apiParameterNotes": null
                        }
                    ],
                    "clonedFromId": null,
                    "apiResourceMethodId": 30135,
                    "apiResourceMethodLogicId": 25615,
                    "apiResourceMethod": "GET"
                },
                {
                    "apiParameters": [
                        {
                            "clonedFromId": null,
                            "apiParameterRestriction": null,
                            "apiParamLogicId": 32647,
                            "pathParamLocationId": 0,
                            "apiParameterRequired": false,
                            "apiParameterType": "json/xml",
                            "apiChildParameters": [
                                {
                                    "clonedFromId": null,
                                    "apiParameterRestriction": null,
                                    "apiParamLogicId": 32648,
                                    "pathParamLocationId": 0,
                                    "apiParameterRequired": true,
                                    "apiParameterType": "json/xml",
                                    "apiChildParameters": [
                                        {
                                            "clonedFromId": null,
                                            "apiParameterRestriction": {
                                                "lengthRestriction": null,
                                                "rangeRestriction": {
                                                    "rangeMax": 999,
                                                    "rangeMin": 1
                                                },
                                                "xmlConversionRule": null,
                                                "numberRangeRestriction": null,
                                                "arrayRestriction": null
                                            },
                                            "apiParamLogicId": 32649,
                                            "pathParamLocationId": 0,
                                            "apiParameterRequired": false,
                                            "apiParameterType": "integer",
                                            "apiChildParameters": [],
                                            "apiParameterId": 35549,
                                            "apiParameterName": "param1",
                                            "apiResourceMethParamId": null,
                                            "array": false,
                                            "apiParameterLocation": null,
                                            "apiParameterNotes": null
                                        },
                                        {
                                            "clonedFromId": null,
                                            "apiParameterRestriction": {
                                                "lengthRestriction": null,
                                                "rangeRestriction": null,
                                                "xmlConversionRule": null,
                                                "numberRangeRestriction": {
                                                    "numberRangeMin": -999.0,
                                                    "numberRangeMax": 999.0
                                                },
                                                "arrayRestriction": null
                                            },
                                            "apiParamLogicId": 32650,
                                            "pathParamLocationId": 0,
                                            "apiParameterRequired": false,
                                            "apiParameterType": "number",
                                            "apiChildParameters": [],
                                            "apiParameterId": 35550,
                                            "apiParameterName": "param-2",
                                            "apiResourceMethParamId": null,
                                            "array": false,
                                            "apiParameterLocation": null,
                                            "apiParameterNotes": null
                                        }
                                    ],
                                    "apiParameterId": 35548,
                                    "apiParameterName": "root",
                                    "apiResourceMethParamId": null,
                                    "array": false,
                                    "apiParameterLocation": null,
                                    "apiParameterNotes": null
                                }
                            ],
                            "apiParameterId": 35547,
                            "apiParameterName": "body-param",
                            "apiResourceMethParamId": 19684,
                            "array": false,
                            "apiParameterLocation": "body",
                            "apiParameterNotes": null
                        }
                    ],
                    "clonedFromId": null,
                    "apiResourceMethodId": 30136,
                    "apiResourceMethodLogicId": 25616,
                    "apiResourceMethod": "POST"
                }
            ],
            "resourcePath": "/respath1",
            "apiResourceLogicId": 14180,
            "link": null,
            "updateDate": "2017-09-06T16:15:45+0000",
            "createdBy": "ccare2",
            "updatedBy": "ccare2",
            "createDate": "2017-09-06T16:15:45+0000",
            "apiResourceId": 12943,
            "apiResourceClonedFromId": null
        }
    ],
    "productionStatus": null,
    "apiEndPointId": 289157,
    "description": null,
    "productionVersion": {
        "status": null,
        "versionNumber": null
    },
    "versionNumber": 1,
    "createdBy": "ccare2",
    "updatedBy": "ccare2",
    "groupId": 44681,
    "contractId": "3-13H55B5",
    "apiEndPointScheme": null,
    "apiEndPointLocked": false,
    "apiCategoryIds": [
        1123
    ],
    "basePath": "/api-basepath",
    "akamaiSecurityRestrictions": {
        "MAX_DOC_DEPTH": 64,
        "MAX_JSONXML_ELEMENT": 10,
        "MAX_BODY_SIZE": 23433454,
        "MAX_INTEGER_VALUE": 999999999,
        "MAX_STRING_LENGTH": 999999999999,
        "MAX_ELEMENT_NAME_LENGTH": 256,
        "POSITIVE_SECURITY_ENABLED": 1
    },
    "clonedFromVersion": null,
    "updateDate": "2017-09-06T16:15:44+0000",
    "apiEndPointHosts": [
        "akamaiflower.rey.edgesuite.net"
    ],
    "consumeType": "any"
}

Create a New API Endpoint from a File Upload

Enter a URL or upload a file in OpenAPI (Swagger) or RAML or to register your API.

POST /api-definitions/v2/endpoints/translate

Content-Type: multipart/form-data

See Parameters for details on upload content.

Parameter Type Sample Description
Form Parameters
importFileFormat Enumeration raml The format of the API descriptor, either raml (0.8) or swagger (2.0).
importFile File %RAML 0.8... The complete file to import.
importUrl String https://example.com/descriptor.raml The URL from which to retrieve the API descriptor file.
root String api_descriptor.raml If the import file is a ZIP archive, This identifies the API descriptor’s filename within the archive.
apiEndPointId Integer 12892 Unique integer identifier for each API endpoint service.
versionNumber Integer 2 Unique integer identifier for each API endpoint version.

Status 200 application/json

Response Body:

{
    "securityScheme": {
        "securitySchemeId": 5083,
        "securitySchemeDetail": {
            "apiKeyLocation": "header",
            "apiKeyName": "header-api"
        },
        "securitySchemeDescription": null,
        "securitySchemeType": "apikey"
    },
    "apiEndPointName": "Test-api",
    "lockVersion": 0,
    "apiEndPointVersion": 320192,
    "stagingVersion": {
        "status": null,
        "versionNumber": null
    },
    "stagingStatus": null,
    "createDate": "2017-09-06T16:15:44+0000",
    "apiResources": [
        {
            "description": "res1-notes",
            "lockVersion": 0,
            "apiResourceName": "/resource-1",
            "apiResourceMethods": [
                {
                    "apiParameters": [
                        {
                            "clonedFromId": null,
                            "apiParameterRestriction": {
                                "lengthRestriction": null,
                                "rangeRestriction": {
                                    "rangeMax": null,
                                    "rangeMin": null
                                },
                                "xmlConversionRule": null,
                                "numberRangeRestriction": null,
                                "arrayRestriction": null
                            },
                            "apiParamLogicId": 32645,
                            "pathParamLocationId": 0,
                            "apiParameterRequired": true,
                            "apiParameterType": "integer",
                            "apiChildParameters": [],
                            "apiParameterId": 35545,
                            "apiParameterName": "param1",
                            "apiResourceMethParamId": 19682,
                            "array": false,
                            "apiParameterLocation": "header",
                            "apiParameterNotes": null
                        },
                        {
                            "clonedFromId": null,
                            "apiParameterRestriction": {
                                "lengthRestriction": null,
                                "rangeRestriction": null,
                                "xmlConversionRule": null,
                                "numberRangeRestriction": {
                                    "numberRangeMin": null,
                                    "numberRangeMax": 999999.0
                                },
                                "arrayRestriction": null
                            },
                            "apiParamLogicId": 32646,
                            "pathParamLocationId": 0,
                            "apiParameterRequired": false,
                            "apiParameterType": "number",
                            "apiChildParameters": [],
                            "apiParameterId": 35546,
                            "apiParameterName": "param-2",
                            "apiResourceMethParamId": 19683,
                            "array": false,
                            "apiParameterLocation": "cookie",
                            "apiParameterNotes": null
                        }
                    ],
                    "clonedFromId": null,
                    "apiResourceMethodId": 30135,
                    "apiResourceMethodLogicId": 25615,
                    "apiResourceMethod": "GET"
                },
                {
                    "apiParameters": [
                        {
                            "clonedFromId": null,
                            "apiParameterRestriction": null,
                            "apiParamLogicId": 32647,
                            "pathParamLocationId": 0,
                            "apiParameterRequired": false,
                            "apiParameterType": "json/xml",
                            "apiChildParameters": [
                                {
                                    "clonedFromId": null,
                                    "apiParameterRestriction": null,
                                    "apiParamLogicId": 32648,
                                    "pathParamLocationId": 0,
                                    "apiParameterRequired": true,
                                    "apiParameterType": "json/xml",
                                    "apiChildParameters": [
                                        {
                                            "clonedFromId": null,
                                            "apiParameterRestriction": {
                                                "lengthRestriction": null,
                                                "rangeRestriction": {
                                                    "rangeMax": 999,
                                                    "rangeMin": 1
                                                },
                                                "xmlConversionRule": null,
                                                "numberRangeRestriction": null,
                                                "arrayRestriction": null
                                            },
                                            "apiParamLogicId": 32649,
                                            "pathParamLocationId": 0,
                                            "apiParameterRequired": false,
                                            "apiParameterType": "integer",
                                            "apiChildParameters": [],
                                            "apiParameterId": 35549,
                                            "apiParameterName": "param1",
                                            "apiResourceMethParamId": null,
                                            "array": false,
                                            "apiParameterLocation": null,
                                            "apiParameterNotes": null
                                        },
                                        {
                                            "clonedFromId": null,
                                            "apiParameterRestriction": {
                                                "lengthRestriction": null,
                                                "rangeRestriction": null,
                                                "xmlConversionRule": null,
                                                "numberRangeRestriction": {
                                                    "numberRangeMin": -999.0,
                                                    "numberRangeMax": 999.0
                                                },
                                                "arrayRestriction": null
                                            },
                                            "apiParamLogicId": 32650,
                                            "pathParamLocationId": 0,
                                            "apiParameterRequired": false,
                                            "apiParameterType": "number",
                                            "apiChildParameters": [],
                                            "apiParameterId": 35550,
                                            "apiParameterName": "param-2",
                                            "apiResourceMethParamId": null,
                                            "array": false,
                                            "apiParameterLocation": null,
                                            "apiParameterNotes": null
                                        }
                                    ],
                                    "apiParameterId": 35548,
                                    "apiParameterName": "root",
                                    "apiResourceMethParamId": null,
                                    "array": false,
                                    "apiParameterLocation": null,
                                    "apiParameterNotes": null
                                }
                            ],
                            "apiParameterId": 35547,
                            "apiParameterName": "body-param",
                            "apiResourceMethParamId": 19684,
                            "array": false,
                            "apiParameterLocation": "body",
                            "apiParameterNotes": null
                        }
                    ],
                    "clonedFromId": null,
                    "apiResourceMethodId": 30136,
                    "apiResourceMethodLogicId": 25616,
                    "apiResourceMethod": "POST"
                }
            ],
            "resourcePath": "/respath1",
            "apiResourceLogicId": 14180,
            "link": null,
            "updateDate": "2017-09-06T16:15:45+0000",
            "createdBy": "ccare2",
            "updatedBy": "ccare2",
            "createDate": "2017-09-06T16:15:45+0000",
            "apiResourceId": 12943,
            "apiResourceClonedFromId": null
        }
    ],
    "productionStatus": null,
    "apiEndPointId": 289157,
    "description": null,
    "productionVersion": {
        "status": null,
        "versionNumber": null
    },
    "versionNumber": 1,
    "createdBy": "ccare2",
    "updatedBy": "ccare2",
    "groupId": 44681,
    "contractId": "3-13H55B5",
    "apiEndPointScheme": null,
    "apiEndPointLocked": false,
    "apiCategoryIds": [
        1123
    ],
    "basePath": "/api-basepath",
    "akamaiSecurityRestrictions": {
        "MAX_DOC_DEPTH": 64,
        "MAX_JSONXML_ELEMENT": 10,
        "MAX_BODY_SIZE": 23433454,
        "MAX_INTEGER_VALUE": 999999999,
        "MAX_STRING_LENGTH": 999999999999,
        "MAX_ELEMENT_NAME_LENGTH": 256,
        "POSITIVE_SECURITY_ENABLED": 1
    },
    "clonedFromVersion": null,
    "updateDate": "2017-09-06T16:15:44+0000",
    "apiEndPointHosts": [
        "akamaiflower.rey.edgesuite.net"
    ],
    "consumeType": "any"
}

List User Entitlements

Lists set of entitlements based on user permissions.

GET /api-definitions/v2/endpoints/user-entitlements

Status 200 application/json

Response Body:

[
    "API_READ",
    "API_WRITE",
    "API_VERSIONING",
    "API_FEATURES",
    "RAPID_FEATURES"
]

Remove an Endpoint

Soft delete the endpoint if none of the versions are activated or pending activation in staging or production network.

DELETE /api-definitions/v2/endpoints/{apiEndPointId}

Sample: /api-definitions/v2/endpoints/12892

Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 12892 Unique integer identifier for each API endpoint service.

Status 204

List Versions

Get all endpoint versions

GET /api-definitions/v2/endpoints/{apiEndPointId}/versions

Sample: /api-definitions/v2/endpoints/12892/versions

Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 12892 Unique integer identifier for each API endpoint service.

Status 200 application/json

Response Body:

{
    "apiEndPointId": 288194,
    "apiVersions": [
        {
            "stagingStatus": null,
            "description": null,
            "apiEndPointVersionId": 320167,
            "lockVersion": 0,
            "basePath": "/RapidAutomationTest__2017_09_06_13_02_52",
            "basedOn": null,
            "isVersionLocked": false,
            "createdBy": "testrapid",
            "updateDate": "2017-09-06T13:02:53+0000",
            "apiEndPointVersionNumber": 1,
            "updatedBy": "testrapid",
            "availableActions": [
                "CLONE",
                "DELETE",
                "VIEW_RAPID_SETTINGS",
                "EDIT_RAPID_SETTINGS",
                "EDIT_ENDPOINT_DEFINITION",
                "ACTIVATE_ON_STAGING",
                "ACTIVATE_ON_PRODUCTION"
            ],
            "productionDate": null,
            "stagingDate": null,
            "createDate": "2017-09-06T13:02:53+0000",
            "productionStatus": null
        },
        {
            "stagingStatus": "DEACTIVATED",
            "description": null,
            "apiEndPointVersionId": 320168,
            "lockVersion": 3,
            "basePath": "/RapidAutomationTest__2017_09_06_13_02_52",
            "basedOn": 1,
            "isVersionLocked": true,
            "createdBy": "testrapid",
            "updateDate": "2017-09-06T13:08:13+0000",
            "apiEndPointVersionNumber": 2,
            "updatedBy": "testrapid",
            "availableActions": [
                "CLONE",
                "VIEW_RAPID_SETTINGS",
                "ACTIVATE_ON_STAGING",
                "ACTIVATE_ON_PRODUCTION"
            ],
            "productionDate": null,
            "stagingDate": "2017-09-06T13:13:04+0000",
            "createDate": "2017-09-06T13:02:54+0000",
            "productionStatus": null
        },
        {
            "stagingStatus": "DEACTIVATED",
            "description": null,
            "apiEndPointVersionId": 320169,
            "lockVersion": 3,
            "basePath": "/RapidAutomationTest__2017_09_06_13_02_52",
            "basedOn": 1,
            "isVersionLocked": true,
            "createdBy": "testrapid",
            "updateDate": "2017-09-06T13:18:25+0000",
            "apiEndPointVersionNumber": 3,
            "updatedBy": "testrapid",
            "availableActions": [
                "CLONE",
                "VIEW_RAPID_SETTINGS",
                "ACTIVATE_ON_STAGING",
                "ACTIVATE_ON_PRODUCTION"
            ],
            "productionDate": null,
            "stagingDate": "2017-09-06T13:23:04+0000",
            "createDate": "2017-09-06T13:08:12+0000",
            "productionStatus": null
        },
        {
            "stagingStatus": "DEACTIVATED",
            "description": null,
            "apiEndPointVersionId": 320170,
            "lockVersion": 3,
            "basePath": "/RapidAutomationTest__2017_09_06_13_02_52",
            "basedOn": 1,
            "isVersionLocked": true,
            "createdBy": "testrapid",
            "updateDate": "2017-09-06T13:24:09+0000",
            "apiEndPointVersionNumber": 4,
            "updatedBy": "testrapid",
            "availableActions": [
                "CLONE",
                "VIEW_RAPID_SETTINGS",
                "ACTIVATE_ON_STAGING",
                "ACTIVATE_ON_PRODUCTION"
            ],
            "productionDate": null,
            "stagingDate": "2017-09-06T13:30:06+0000",
            "createDate": "2017-09-06T13:08:16+0000",
            "productionStatus": null
        },
        {
            "stagingStatus": null,
            "description": null,
            "apiEndPointVersionId": 320171,
            "lockVersion": 0,
            "basePath": "/RapidAutomationTest__2017_09_06_13_02_52",
            "basedOn": 1,
            "isVersionLocked": false,
            "createdBy": "testrapid",
            "updateDate": "2017-09-06T13:18:26+0000",
            "apiEndPointVersionNumber": 5,
            "updatedBy": "testrapid",
            "availableActions": [
                "CLONE",
                "DELETE",
                "VIEW_RAPID_SETTINGS",
                "EDIT_RAPID_SETTINGS",
                "EDIT_ENDPOINT_DEFINITION",
                "ACTIVATE_ON_STAGING",
                "ACTIVATE_ON_PRODUCTION"
            ],
            "productionDate": null,
            "stagingDate": null,
            "createDate": "2017-09-06T13:18:26+0000",
            "productionStatus": null
        },
        {
            "stagingStatus": null,
            "description": null,
            "apiEndPointVersionId": 320172,
            "lockVersion": 0,
            "basePath": "/RapidAutomationTest__2017_09_06_13_02_52",
            "basedOn": 1,
            "isVersionLocked": false,
            "createdBy": "testrapid",
            "updateDate": "2017-09-06T13:18:29+0000",
            "apiEndPointVersionNumber": 6,
            "updatedBy": "testrapid",
            "availableActions": [
                "CLONE",
                "DELETE",
                "VIEW_RAPID_SETTINGS",
                "EDIT_RAPID_SETTINGS",
                "EDIT_ENDPOINT_DEFINITION",
                "ACTIVATE_ON_STAGING",
                "ACTIVATE_ON_PRODUCTION"
            ],
            "productionDate": null,
            "stagingDate": null,
            "createDate": "2017-09-06T13:18:29+0000",
            "productionStatus": null
        },
        {
            "stagingStatus": null,
            "description": null,
            "apiEndPointVersionId": 320173,
            "lockVersion": 0,
            "basePath": "/RapidAutomationTest__2017_09_06_13_02_52",
            "basedOn": 1,
            "isVersionLocked": false,
            "createdBy": "testrapid",
            "updateDate": "2017-09-06T13:18:31+0000",
            "apiEndPointVersionNumber": 7,
            "updatedBy": "testrapid",
            "availableActions": [
                "CLONE",
                "DELETE",
                "VIEW_RAPID_SETTINGS",
                "EDIT_RAPID_SETTINGS",
                "EDIT_ENDPOINT_DEFINITION",
                "ACTIVATE_ON_STAGING",
                "ACTIVATE_ON_PRODUCTION"
            ],
            "productionDate": null,
            "stagingDate": null,
            "createDate": "2017-09-06T13:18:31+0000",
            "productionStatus": null
        },
        {
            "stagingStatus": null,
            "description": null,
            "apiEndPointVersionId": 320174,
            "lockVersion": 0,
            "basePath": "/RapidAutomationTest__2017_09_06_13_02_52",
            "basedOn": 1,
            "isVersionLocked": false,
            "createdBy": "testrapid",
            "updateDate": "2017-09-06T13:18:33+0000",
            "apiEndPointVersionNumber": 8,
            "updatedBy": "testrapid",
            "availableActions": [
                "CLONE",
                "DELETE",
                "VIEW_RAPID_SETTINGS",
                "EDIT_RAPID_SETTINGS",
                "EDIT_ENDPOINT_DEFINITION",
                "ACTIVATE_ON_STAGING",
                "ACTIVATE_ON_PRODUCTION"
            ],
            "productionDate": null,
            "stagingDate": null,
            "createDate": "2017-09-06T13:18:33+0000",
            "productionStatus": null
        },
        {
            "stagingStatus": null,
            "description": null,
            "apiEndPointVersionId": 320175,
            "lockVersion": 0,
            "basePath": "/RapidAutomationTest__2017_09_06_13_02_52",
            "basedOn": 1,
            "isVersionLocked": false,
            "createdBy": "testrapid",
            "updateDate": "2017-09-06T13:18:34+0000",
            "apiEndPointVersionNumber": 9,
            "updatedBy": "testrapid",
            "availableActions": [
                "CLONE",
                "DELETE",
                "VIEW_RAPID_SETTINGS",
                "EDIT_RAPID_SETTINGS",
                "EDIT_ENDPOINT_DEFINITION",
                "ACTIVATE_ON_STAGING",
                "ACTIVATE_ON_PRODUCTION"
            ],
            "productionDate": null,
            "stagingDate": null,
            "createDate": "2017-09-06T13:18:34+0000",
            "productionStatus": null
        },
        {
            "stagingStatus": null,
            "description": null,
            "apiEndPointVersionId": 320176,
            "lockVersion": 4,
            "basePath": "/RapidAutomationTest__2017_09_06_13_02_52",
            "basedOn": 1,
            "isVersionLocked": true,
            "createdBy": "testrapid",
            "updateDate": "2017-09-06T13:24:06+0000",
            "apiEndPointVersionNumber": 10,
            "updatedBy": "testrapid",
            "availableActions": [
                "CLONE",
                "VIEW_RAPID_SETTINGS",
                "ACTIVATE_ON_STAGING",
                "ACTIVATE_ON_PRODUCTION"
            ],
            "productionDate": "2017-09-06T13:31:04+0000",
            "stagingDate": null,
            "createDate": "2017-09-06T13:18:38+0000",
            "productionStatus": "DEACTIVATED"
        },
        {
            "stagingStatus": "ACTIVE",
            "description": null,
            "apiEndPointVersionId": 320177,
            "lockVersion": 2,
            "basePath": "/RapidAutomationTest__2017_09_06_13_02_52",
            "basedOn": 1,
            "isVersionLocked": true,
            "createdBy": "testrapid",
            "updateDate": "2017-09-06T13:24:09+0000",
            "apiEndPointVersionNumber": 11,
            "updatedBy": "testrapid",
            "availableActions": [
                "CLONE",
                "VIEW_RAPID_SETTINGS",
                "DEACTIVATE_ON_STAGING",
                "ACTIVATE_ON_PRODUCTION"
            ],
            "productionDate": null,
            "stagingDate": "2017-09-06T13:30:06+0000",
            "createDate": "2017-09-06T13:24:07+0000",
            "productionStatus": null
        },
        {
            "stagingStatus": null,
            "description": null,
            "apiEndPointVersionId": 320178,
            "lockVersion": 0,
            "basePath": "/RapidAutomationTest__2017_09_06_13_02_52",
            "basedOn": 1,
            "isVersionLocked": false,
            "createdBy": "testrapid",
            "updateDate": "2017-09-06T13:24:12+0000",
            "apiEndPointVersionNumber": 12,
            "updatedBy": "testrapid",
            "availableActions": [
                "CLONE",
                "DELETE",
                "VIEW_RAPID_SETTINGS",
                "EDIT_RAPID_SETTINGS",
                "EDIT_ENDPOINT_DEFINITION",
                "ACTIVATE_ON_STAGING",
                "ACTIVATE_ON_PRODUCTION"
            ],
            "productionDate": null,
            "stagingDate": null,
            "createDate": "2017-09-06T13:24:12+0000",
            "productionStatus": null
        },
        {
            "stagingStatus": null,
            "description": null,
            "apiEndPointVersionId": 320179,
            "lockVersion": 0,
            "basePath": "/RapidAutomationTest__2017_09_06_13_02_52",
            "basedOn": 1,
            "isVersionLocked": false,
            "createdBy": "testrapid",
            "updateDate": "2017-09-06T13:24:14+0000",
            "apiEndPointVersionNumber": 13,
            "updatedBy": "testrapid",
            "availableActions": [
                "CLONE",
                "DELETE",
                "VIEW_RAPID_SETTINGS",
                "EDIT_RAPID_SETTINGS",
                "EDIT_ENDPOINT_DEFINITION",
                "ACTIVATE_ON_STAGING",
                "ACTIVATE_ON_PRODUCTION"
            ],
            "productionDate": null,
            "stagingDate": null,
            "createDate": "2017-09-06T13:24:14+0000",
            "productionStatus": null
        }
    ],
    "apiEndPointName": "RapidAutomationTest__2017_09_06_13_02_52"
}

Modify a Version

Update details about a specific endpoint version.

PUT /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}

Sample: /api-definitions/v2/endpoints/12892/versions/1

Content-Type: application/json

Request Body:

{
    "securityScheme": {
        "securitySchemeId": 4523,
        "securitySchemeDetail": {
            "apiKeyLocation": "header",
            "apiKeyName": "header-101"
        },
        "securitySchemeDescription": null,
        "securitySchemeType": "apikey"
    },
    "apiEndPointName": "API Test",
    "lockVersion": 0,
    "apiEndPointVersion": 326202,
    "stagingVersion": {
        "status": null,
        "versionNumber": null
    },
    "stagingStatus": null,
    "createDate": "2017-11-17T19:27:07+0000",
    "apiResources": [],
    "protectedByApiKey": false,
    "productionStatus": null,
    "apiEndPointId": 314252,
    "description": "API test description",
    "productionVersion": {
        "status": null,
        "versionNumber": null
    },
    "versionNumber": 1,
    "createdBy": "ccare2",
    "updatedBy": "ccare2",
    "groupId": 44681,
    "contractId": "3-13H55B5",
    "apiEndPointScheme": null,
    "apiEndPointLocked": false,
    "apiCategoryIds": [
        161
    ],
    "basePath": "/api/test/basepath",
    "akamaiSecurityRestrictions": {
        "MAX_DOC_DEPTH": 64,
        "MAX_JSONXML_ELEMENT": 1032,
        "MAX_BODY_SIZE": 61056,
        "MAX_INTEGER_VALUE": 9999,
        "MAX_STRING_LENGTH": 8192,
        "MAX_ELEMENT_NAME_LENGTH": 256,
        "POSITIVE_SECURITY_ENABLED": 1
    },
    "clonedFromVersion": null,
    "updateDate": "2017-11-17T19:27:07+0000",
    "apiEndPointHosts": [
        "www.akamatest.com"
    ],
    "consumeType": "json/xml"
}
Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 12892 Unique integer identifier for each API endpoint service.
versionNumber Integer 1 A unique identifier for each API endpoint version.

Status 200 application/json

Response Body:

{
    "securityScheme": {
        "securitySchemeId": 4523,
        "securitySchemeDetail": {
            "apiKeyLocation": "header",
            "apiKeyName": "header-101"
        },
        "securitySchemeDescription": null,
        "securitySchemeType": "apikey"
    },
    "apiEndPointName": "API Test",
    "lockVersion": 0,
    "apiEndPointVersion": 326202,
    "stagingVersion": {
        "status": null,
        "versionNumber": null
    },
    "stagingStatus": null,
    "createDate": "2017-11-17T19:27:07+0000",
    "apiResources": [],
    "protectedByApiKey": false,
    "productionStatus": null,
    "apiEndPointId": 314252,
    "description": "API test description",
    "productionVersion": {
        "status": null,
        "versionNumber": null
    },
    "versionNumber": 1,
    "createdBy": "ccare2",
    "updatedBy": "ccare2",
    "groupId": 44681,
    "contractId": "3-13H55B5",
    "apiEndPointScheme": null,
    "apiEndPointLocked": false,
    "apiCategoryIds": [
        161
    ],
    "basePath": "/api/test/basepath",
    "akamaiSecurityRestrictions": {
        "MAX_DOC_DEPTH": 64,
        "MAX_JSONXML_ELEMENT": 1032,
        "MAX_BODY_SIZE": 61056,
        "MAX_INTEGER_VALUE": 9999,
        "MAX_STRING_LENGTH": 8192,
        "MAX_ELEMENT_NAME_LENGTH": 256,
        "POSITIVE_SECURITY_ENABLED": 1
    },
    "clonedFromVersion": null,
    "updateDate": "2017-11-17T19:27:07+0000",
    "apiEndPointHosts": [
        "www.akamatest.com"
    ],
    "consumeType": "json/xml"
}

Remove a Version

Soft delete an Endpoint version provided the version is not activated in the staging or production network.

DELETE /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}

Sample: /api-definitions/v2/endpoints/12892/versions/1

Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 12892 Unique integer identifier for each API endpoint service.
versionNumber Integer 1 A unique identifier for each API endpoint version.

Status 204

Get a Version

Get the endpoint version with all resources details.

GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/resources-detail

Sample: /api-definitions/v2/endpoints/12892/versions/1/resources-detail

Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 12892 Unique integer identifier for each API endpoint service.
versionNumber Integer 1 A unique identifier for each API endpoint version.

Status 200 application/json

Response Body:

{
    "securityScheme": {
        "securitySchemeId": 5083,
        "securitySchemeDetail": {
            "apiKeyLocation": "header",
            "apiKeyName": "header-api"
        },
        "securitySchemeDescription": null,
        "securitySchemeType": "apikey"
    },
    "apiEndPointName": "Test-api",
    "lockVersion": 0,
    "apiEndPointVersion": 320192,
    "stagingVersion": {
        "status": null,
        "versionNumber": null
    },
    "stagingStatus": null,
    "createDate": "2017-09-06T16:15:44+0000",
    "apiResources": [
        {
            "description": "res1-notes",
            "lockVersion": 0,
            "apiResourceName": "/resource-1",
            "apiResourceMethods": [
                {
                    "apiParameters": [
                        {
                            "clonedFromId": null,
                            "apiParameterRestriction": {
                                "lengthRestriction": null,
                                "rangeRestriction": {
                                    "rangeMax": null,
                                    "rangeMin": null
                                },
                                "xmlConversionRule": null,
                                "numberRangeRestriction": null,
                                "arrayRestriction": null
                            },
                            "apiParamLogicId": 32645,
                            "pathParamLocationId": 0,
                            "apiParameterRequired": true,
                            "apiParameterType": "integer",
                            "apiChildParameters": [],
                            "apiParameterId": 35545,
                            "apiParameterName": "param1",
                            "apiResourceMethParamId": 19682,
                            "array": false,
                            "apiParameterLocation": "header",
                            "apiParameterNotes": null
                        },
                        {
                            "clonedFromId": null,
                            "apiParameterRestriction": {
                                "lengthRestriction": null,
                                "rangeRestriction": null,
                                "xmlConversionRule": null,
                                "numberRangeRestriction": {
                                    "numberRangeMin": null,
                                    "numberRangeMax": 999999.0
                                },
                                "arrayRestriction": null
                            },
                            "apiParamLogicId": 32646,
                            "pathParamLocationId": 0,
                            "apiParameterRequired": false,
                            "apiParameterType": "number",
                            "apiChildParameters": [],
                            "apiParameterId": 35546,
                            "apiParameterName": "param-2",
                            "apiResourceMethParamId": 19683,
                            "array": false,
                            "apiParameterLocation": "cookie",
                            "apiParameterNotes": null
                        }
                    ],
                    "clonedFromId": null,
                    "apiResourceMethodId": 30135,
                    "apiResourceMethodLogicId": 25615,
                    "apiResourceMethod": "GET"
                },
                {
                    "apiParameters": [
                        {
                            "clonedFromId": null,
                            "apiParameterRestriction": null,
                            "apiParamLogicId": 32647,
                            "pathParamLocationId": 0,
                            "apiParameterRequired": false,
                            "apiParameterType": "json/xml",
                            "apiChildParameters": [
                                {
                                    "clonedFromId": null,
                                    "apiParameterRestriction": null,
                                    "apiParamLogicId": 32648,
                                    "pathParamLocationId": 0,
                                    "apiParameterRequired": true,
                                    "apiParameterType": "json/xml",
                                    "apiChildParameters": [
                                        {
                                            "clonedFromId": null,
                                            "apiParameterRestriction": {
                                                "lengthRestriction": null,
                                                "rangeRestriction": {
                                                    "rangeMax": 999,
                                                    "rangeMin": 1
                                                },
                                                "xmlConversionRule": null,
                                                "numberRangeRestriction": null,
                                                "arrayRestriction": null
                                            },
                                            "apiParamLogicId": 32649,
                                            "pathParamLocationId": 0,
                                            "apiParameterRequired": false,
                                            "apiParameterType": "integer",
                                            "apiChildParameters": [],
                                            "apiParameterId": 35549,
                                            "apiParameterName": "param1",
                                            "apiResourceMethParamId": null,
                                            "array": false,
                                            "apiParameterLocation": null,
                                            "apiParameterNotes": null
                                        },
                                        {
                                            "clonedFromId": null,
                                            "apiParameterRestriction": {
                                                "lengthRestriction": null,
                                                "rangeRestriction": null,
                                                "xmlConversionRule": null,
                                                "numberRangeRestriction": {
                                                    "numberRangeMin": -999.0,
                                                    "numberRangeMax": 999.0
                                                },
                                                "arrayRestriction": null
                                            },
                                            "apiParamLogicId": 32650,
                                            "pathParamLocationId": 0,
                                            "apiParameterRequired": false,
                                            "apiParameterType": "number",
                                            "apiChildParameters": [],
                                            "apiParameterId": 35550,
                                            "apiParameterName": "param-2",
                                            "apiResourceMethParamId": null,
                                            "array": false,
                                            "apiParameterLocation": null,
                                            "apiParameterNotes": null
                                        }
                                    ],
                                    "apiParameterId": 35548,
                                    "apiParameterName": "root",
                                    "apiResourceMethParamId": null,
                                    "array": false,
                                    "apiParameterLocation": null,
                                    "apiParameterNotes": null
                                }
                            ],
                            "apiParameterId": 35547,
                            "apiParameterName": "body-param",
                            "apiResourceMethParamId": 19684,
                            "array": false,
                            "apiParameterLocation": "body",
                            "apiParameterNotes": null
                        }
                    ],
                    "clonedFromId": null,
                    "apiResourceMethodId": 30136,
                    "apiResourceMethodLogicId": 25616,
                    "apiResourceMethod": "POST"
                }
            ],
            "resourcePath": "/respath1",
            "apiResourceLogicId": 14180,
            "link": null,
            "updateDate": "2017-09-06T16:15:45+0000",
            "createdBy": "ccare2",
            "updatedBy": "ccare2",
            "createDate": "2017-09-06T16:15:45+0000",
            "apiResourceId": 12943,
            "apiResourceClonedFromId": null
        }
    ],
    "productionStatus": null,
    "apiEndPointId": 289157,
    "description": null,
    "productionVersion": {
        "status": null,
        "versionNumber": null
    },
    "versionNumber": 1,
    "createdBy": "ccare2",
    "updatedBy": "ccare2",
    "groupId": 44681,
    "contractId": "3-13H55B5",
    "apiEndPointScheme": null,
    "apiEndPointLocked": false,
    "apiCategoryIds": [
        1123
    ],
    "basePath": "/api-basepath",
    "akamaiSecurityRestrictions": {
        "MAX_DOC_DEPTH": 64,
        "MAX_JSONXML_ELEMENT": 10,
        "MAX_BODY_SIZE": 23433454,
        "MAX_INTEGER_VALUE": 999999999,
        "MAX_STRING_LENGTH": 999999999999,
        "MAX_ELEMENT_NAME_LENGTH": 256,
        "POSITIVE_SECURITY_ENABLED": 1
    },
    "clonedFromVersion": null,
    "updateDate": "2017-09-06T16:15:44+0000",
    "apiEndPointHosts": [
        "akamaiflower.rey.edgesuite.net"
    ],
    "consumeType": "any"
}

Clone a Version

Clones a new version from the existing version specified

POST /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/cloneVersion

Sample: /api-definitions/v2/endpoints/12892/versions/1/cloneVersion

Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 12892 Unique integer identifier for each API endpoint service.
versionNumber Integer 1 A unique identifier for each API endpoint version.

Status 200 application/json

Response Body:

{
    "securityScheme": {
        "securitySchemeId": 5083,
        "securitySchemeDetail": {
            "apiKeyLocation": "header",
            "apiKeyName": "header-api"
        },
        "securitySchemeDescription": null,
        "securitySchemeType": "apikey"
    },
    "apiEndPointName": "Test-api",
    "lockVersion": 0,
    "apiEndPointVersion": 320192,
    "stagingVersion": {
        "status": null,
        "versionNumber": null
    },
    "stagingStatus": null,
    "createDate": "2017-09-06T16:15:44+0000",
    "apiResources": [
        {
            "description": "res1-notes",
            "lockVersion": 0,
            "apiResourceName": "/resource-1",
            "apiResourceMethods": [
                {
                    "apiParameters": [
                        {
                            "clonedFromId": null,
                            "apiParameterRestriction": {
                                "lengthRestriction": null,
                                "rangeRestriction": {
                                    "rangeMax": null,
                                    "rangeMin": null
                                },
                                "xmlConversionRule": null,
                                "numberRangeRestriction": null,
                                "arrayRestriction": null
                            },
                            "apiParamLogicId": 32645,
                            "pathParamLocationId": 0,
                            "apiParameterRequired": true,
                            "apiParameterType": "integer",
                            "apiChildParameters": [],
                            "apiParameterId": 35545,
                            "apiParameterName": "param1",
                            "apiResourceMethParamId": 19682,
                            "array": false,
                            "apiParameterLocation": "header",
                            "apiParameterNotes": null
                        },
                        {
                            "clonedFromId": null,
                            "apiParameterRestriction": {
                                "lengthRestriction": null,
                                "rangeRestriction": null,
                                "xmlConversionRule": null,
                                "numberRangeRestriction": {
                                    "numberRangeMin": null,
                                    "numberRangeMax": 999999.0
                                },
                                "arrayRestriction": null
                            },
                            "apiParamLogicId": 32646,
                            "pathParamLocationId": 0,
                            "apiParameterRequired": false,
                            "apiParameterType": "number",
                            "apiChildParameters": [],
                            "apiParameterId": 35546,
                            "apiParameterName": "param-2",
                            "apiResourceMethParamId": 19683,
                            "array": false,
                            "apiParameterLocation": "cookie",
                            "apiParameterNotes": null
                        }
                    ],
                    "clonedFromId": null,
                    "apiResourceMethodId": 30135,
                    "apiResourceMethodLogicId": 25615,
                    "apiResourceMethod": "GET"
                },
                {
                    "apiParameters": [
                        {
                            "clonedFromId": null,
                            "apiParameterRestriction": null,
                            "apiParamLogicId": 32647,
                            "pathParamLocationId": 0,
                            "apiParameterRequired": false,
                            "apiParameterType": "json/xml",
                            "apiChildParameters": [
                                {
                                    "clonedFromId": null,
                                    "apiParameterRestriction": null,
                                    "apiParamLogicId": 32648,
                                    "pathParamLocationId": 0,
                                    "apiParameterRequired": true,
                                    "apiParameterType": "json/xml",
                                    "apiChildParameters": [
                                        {
                                            "clonedFromId": null,
                                            "apiParameterRestriction": {
                                                "lengthRestriction": null,
                                                "rangeRestriction": {
                                                    "rangeMax": 999,
                                                    "rangeMin": 1
                                                },
                                                "xmlConversionRule": null,
                                                "numberRangeRestriction": null,
                                                "arrayRestriction": null
                                            },
                                            "apiParamLogicId": 32649,
                                            "pathParamLocationId": 0,
                                            "apiParameterRequired": false,
                                            "apiParameterType": "integer",
                                            "apiChildParameters": [],
                                            "apiParameterId": 35549,
                                            "apiParameterName": "param1",
                                            "apiResourceMethParamId": null,
                                            "array": false,
                                            "apiParameterLocation": null,
                                            "apiParameterNotes": null
                                        },
                                        {
                                            "clonedFromId": null,
                                            "apiParameterRestriction": {
                                                "lengthRestriction": null,
                                                "rangeRestriction": null,
                                                "xmlConversionRule": null,
                                                "numberRangeRestriction": {
                                                    "numberRangeMin": -999.0,
                                                    "numberRangeMax": 999.0
                                                },
                                                "arrayRestriction": null
                                            },
                                            "apiParamLogicId": 32650,
                                            "pathParamLocationId": 0,
                                            "apiParameterRequired": false,
                                            "apiParameterType": "number",
                                            "apiChildParameters": [],
                                            "apiParameterId": 35550,
                                            "apiParameterName": "param-2",
                                            "apiResourceMethParamId": null,
                                            "array": false,
                                            "apiParameterLocation": null,
                                            "apiParameterNotes": null
                                        }
                                    ],
                                    "apiParameterId": 35548,
                                    "apiParameterName": "root",
                                    "apiResourceMethParamId": null,
                                    "array": false,
                                    "apiParameterLocation": null,
                                    "apiParameterNotes": null
                                }
                            ],
                            "apiParameterId": 35547,
                            "apiParameterName": "body-param",
                            "apiResourceMethParamId": 19684,
                            "array": false,
                            "apiParameterLocation": "body",
                            "apiParameterNotes": null
                        }
                    ],
                    "clonedFromId": null,
                    "apiResourceMethodId": 30136,
                    "apiResourceMethodLogicId": 25616,
                    "apiResourceMethod": "POST"
                }
            ],
            "resourcePath": "/respath1",
            "apiResourceLogicId": 14180,
            "link": null,
            "updateDate": "2017-09-06T16:15:45+0000",
            "createdBy": "ccare2",
            "updatedBy": "ccare2",
            "createDate": "2017-09-06T16:15:45+0000",
            "apiResourceId": 12943,
            "apiResourceClonedFromId": null
        }
    ],
    "productionStatus": null,
    "apiEndPointId": 289157,
    "description": null,
    "productionVersion": {
        "status": null,
        "versionNumber": null
    },
    "versionNumber": 1,
    "createdBy": "ccare2",
    "updatedBy": "ccare2",
    "groupId": 44681,
    "contractId": "3-13H55B5",
    "apiEndPointScheme": null,
    "apiEndPointLocked": false,
    "apiCategoryIds": [
        1123
    ],
    "basePath": "/api-basepath",
    "akamaiSecurityRestrictions": {
        "MAX_DOC_DEPTH": 64,
        "MAX_JSONXML_ELEMENT": 10,
        "MAX_BODY_SIZE": 23433454,
        "MAX_INTEGER_VALUE": 999999999,
        "MAX_STRING_LENGTH": 999999999999,
        "MAX_ELEMENT_NAME_LENGTH": 256,
        "POSITIVE_SECURITY_ENABLED": 1
    },
    "clonedFromVersion": null,
    "updateDate": "2017-09-06T16:15:44+0000",
    "apiEndPointHosts": [
        "akamaiflower.rey.edgesuite.net"
    ],
    "consumeType": "any"
}

Activate a Version

Activate an API endpoint version to the specified network.

POST /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/activate

Sample: /api-definitions/v2/endpoints/12892/versions/1/activate

Content-Type: application/json

Request Body:

{
    "notes": "New endpoint for creating products",
    "networks": [
        "STAGING",
        "PRODUCTION"
    ],
    "notificationRecipients": [
        "dummy@akamai.com"
    ]
}
Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 12892 Unique integer identifier for each API endpoint service.
versionNumber Integer 1 A unique identifier for each API endpoint version.

Status 200

Deactivate a Version

Deactivate an api endpoint version from the specified network.

POST /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/deactivate

Sample: /api-definitions/v2/endpoints/12892/versions/1/deactivate

Content-Type: application/json

Request Body:

{
    "notes": "New endpoint for creating products",
    "networks": [
        "STAGING",
        "PRODUCTION"
    ],
    "notificationRecipients": [
        "dummy@akamai.com"
    ]
}
Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 12892 Unique integer identifier for each API endpoint service.
versionNumber Integer 1 A unique identifier for each API endpoint version.

Status 200

List Resources

Lists all resources defined for a given API endpoint.

GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/resources

Sample: /api-definitions/v2/endpoints/12892/versions/1/resources

Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 12892 Unique integer identifier for each API endpoint service.
versionNumber Integer 1 A unique identifier for each API endpoint version.

Status 200 application/json

Response Body:

{
    "apiResourceClonedFromId": null,
    "lockVersion": 18298372979,
    "apiResourceName": "cloud security",
    "apiResourceMethods": [
        {
            "apiParameters": [
                {
                    "clonedFromId": null,
                    "apiParameterRestriction": {
                        "rangeRestriction": {
                            "rangeMax": 15,
                            "rangeMin": 6
                        }
                    },
                    "apiParamLogicId": 32649,
                    "apiParameterRequired": true,
                    "apiParameterType": "integer",
                    "apiParameterName": "endpoint-id",
                    "apiParameterId": 9230,
                    "array": false,
                    "apiParameterLocation": "path",
                    "apiParameterNotes": null
                },
                {
                    "clonedFromId": null,
                    "apiParameterRestriction": null,
                    "apiParamLogicId": 32650,
                    "apiParameterRequired": true,
                    "apiParameterType": "string",
                    "apiParameterName": "resourceId",
                    "apiParameterId": 8793,
                    "array": false,
                    "apiParameterLocation": "path",
                    "apiParameterNotes": null
                }
            ],
            "clonedFromId": null,
            "apiResourceMethodId": 1902,
            "apiResourceMethodLogicId": 25615,
            "apiResourceMethod": "GET"
        }
    ],
    "resourcePath": "/resources/{resourceId}",
    "apiResourceLogicId": 14180,
    "updateDate": "2015-10-07T17:41:52+0000",
    "createdBy": "rsahk",
    "updatedBy": "rsahk",
    "createDate": "2013-10-07T17:41:52+0000",
    "apiResourceId": 12893,
    "description": "resource description"
}

Create a New Resource

Create a new resource within an API endpoint service. The resource’s full URL (concatenated hostname, basePath, and resourcepath) needs to be unique within the account.

POST /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/resources

Sample: /api-definitions/v2/endpoints/12892/versions/1/resources

Content-Type: application/json

Request Body:

{
    "apiResourceClonedFromId": null,
    "lockVersion": 18298372979,
    "apiResourceName": "cloud security",
    "apiResourceMethods": [
        {
            "apiParameters": [
                {
                    "clonedFromId": null,
                    "apiParameterRestriction": {
                        "rangeRestriction": {
                            "rangeMax": 15,
                            "rangeMin": 6
                        }
                    },
                    "apiParamLogicId": 32649,
                    "apiParameterRequired": true,
                    "apiParameterType": "integer",
                    "apiParameterName": "endpoint-id",
                    "apiParameterId": 9230,
                    "array": false,
                    "apiParameterLocation": "path",
                    "apiParameterNotes": null
                },
                {
                    "clonedFromId": null,
                    "apiParameterRestriction": null,
                    "apiParamLogicId": 32650,
                    "apiParameterRequired": true,
                    "apiParameterType": "string",
                    "apiParameterName": "resourceId",
                    "apiParameterId": 8793,
                    "array": false,
                    "apiParameterLocation": "path",
                    "apiParameterNotes": null
                }
            ],
            "clonedFromId": null,
            "apiResourceMethodId": 1902,
            "apiResourceMethodLogicId": 25615,
            "apiResourceMethod": "GET"
        }
    ],
    "resourcePath": "/resources/{resourceId}",
    "apiResourceLogicId": 14180,
    "updateDate": "2015-10-07T17:41:52+0000",
    "createdBy": "rsahk",
    "updatedBy": "rsahk",
    "createDate": "2013-10-07T17:41:52+0000",
    "apiResourceId": 12893,
    "description": "resource description"
}
Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 12892 Unique integer identifier for each API endpoint service.
versionNumber Integer 1 A unique identifier for each API endpoint version.

Status 201 application/json

Headers:

Location: /api-definitions/v1/endpoints/123/resources/1234

Response Body:

{
    "apiResourceClonedFromId": null,
    "lockVersion": 18298372979,
    "apiResourceName": "cloud security",
    "apiResourceMethods": [
        {
            "apiParameters": [
                {
                    "clonedFromId": null,
                    "apiParameterRestriction": {
                        "rangeRestriction": {
                            "rangeMax": 15,
                            "rangeMin": 6
                        }
                    },
                    "apiParamLogicId": 32649,
                    "apiParameterRequired": true,
                    "apiParameterType": "integer",
                    "apiParameterName": "endpoint-id",
                    "apiParameterId": 9230,
                    "array": false,
                    "apiParameterLocation": "path",
                    "apiParameterNotes": null
                },
                {
                    "clonedFromId": null,
                    "apiParameterRestriction": null,
                    "apiParamLogicId": 32650,
                    "apiParameterRequired": true,
                    "apiParameterType": "string",
                    "apiParameterName": "resourceId",
                    "apiParameterId": 8793,
                    "array": false,
                    "apiParameterLocation": "path",
                    "apiParameterNotes": null
                }
            ],
            "clonedFromId": null,
            "apiResourceMethodId": 1902,
            "apiResourceMethodLogicId": 25615,
            "apiResourceMethod": "GET"
        }
    ],
    "resourcePath": "/resources/{resourceId}",
    "apiResourceLogicId": 14180,
    "updateDate": "2015-10-07T17:41:52+0000",
    "createdBy": "rsahk",
    "updatedBy": "rsahk",
    "createDate": "2013-10-07T17:41:52+0000",
    "apiResourceId": 12893,
    "description": "resource description"
}

Get a Resource

Get a specific resource within an API endpoint service.

GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/resources/{apiResourceId}

Sample: /api-definitions/v2/endpoints/12892/versions/1/resources/7689

Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 12892 Unique integer identifier for each API endpoint service.
versionNumber Integer 1 A unique identifier for each API endpoint version.
apiResourceId Integer 7689 A unique Akamai integer identifier for each API resource.

Status 200 application/json

Response Body:

{
    "apiResourceClonedFromId": null,
    "lockVersion": 18298372979,
    "apiResourceName": "cloud security",
    "apiResourceMethods": [
        {
            "apiParameters": [
                {
                    "clonedFromId": null,
                    "apiParameterRestriction": {
                        "rangeRestriction": {
                            "rangeMax": 15,
                            "rangeMin": 6
                        }
                    },
                    "apiParamLogicId": 32649,
                    "apiParameterRequired": true,
                    "apiParameterType": "integer",
                    "apiParameterName": "endpoint-id",
                    "apiParameterId": 9230,
                    "array": false,
                    "apiParameterLocation": "path",
                    "apiParameterNotes": null
                },
                {
                    "clonedFromId": null,
                    "apiParameterRestriction": null,
                    "apiParamLogicId": 32650,
                    "apiParameterRequired": true,
                    "apiParameterType": "string",
                    "apiParameterName": "resourceId",
                    "apiParameterId": 8793,
                    "array": false,
                    "apiParameterLocation": "path",
                    "apiParameterNotes": null
                }
            ],
            "clonedFromId": null,
            "apiResourceMethodId": 1902,
            "apiResourceMethodLogicId": 25615,
            "apiResourceMethod": "GET"
        }
    ],
    "resourcePath": "/resources/{resourceId}",
    "apiResourceLogicId": 14180,
    "updateDate": "2015-10-07T17:41:52+0000",
    "createdBy": "rsahk",
    "updatedBy": "rsahk",
    "createDate": "2013-10-07T17:41:52+0000",
    "apiResourceId": 12893,
    "description": "resource description"
}

Modify a Resource

Modify a specific resource within an API endpoint service.

PUT /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/resources/{apiResourceId}

Sample: /api-definitions/v2/endpoints/12892/versions/1/resources/7689

Content-Type: application/json

Request Body:

{
    "apiResourceClonedFromId": null,
    "lockVersion": 18298372979,
    "apiResourceName": "cloud security",
    "apiResourceMethods": [
        {
            "apiParameters": [
                {
                    "clonedFromId": null,
                    "apiParameterRestriction": {
                        "rangeRestriction": {
                            "rangeMax": 15,
                            "rangeMin": 6
                        }
                    },
                    "apiParamLogicId": 32649,
                    "apiParameterRequired": true,
                    "apiParameterType": "integer",
                    "apiParameterName": "endpoint-id",
                    "apiParameterId": 9230,
                    "array": false,
                    "apiParameterLocation": "path",
                    "apiParameterNotes": null
                },
                {
                    "clonedFromId": null,
                    "apiParameterRestriction": null,
                    "apiParamLogicId": 32650,
                    "apiParameterRequired": true,
                    "apiParameterType": "string",
                    "apiParameterName": "resourceId",
                    "apiParameterId": 8793,
                    "array": false,
                    "apiParameterLocation": "path",
                    "apiParameterNotes": null
                }
            ],
            "clonedFromId": null,
            "apiResourceMethodId": 1902,
            "apiResourceMethodLogicId": 25615,
            "apiResourceMethod": "GET"
        }
    ],
    "resourcePath": "/resources/{resourceId}",
    "apiResourceLogicId": 14180,
    "updateDate": "2015-10-07T17:41:52+0000",
    "createdBy": "rsahk",
    "updatedBy": "rsahk",
    "createDate": "2013-10-07T17:41:52+0000",
    "apiResourceId": 12893,
    "description": "resource description"
}
Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 12892 Unique integer identifier for each API endpoint service.
versionNumber Integer 1 A unique identifier for each API endpoint version.
apiResourceId Integer 7689 A unique Akamai integer identifier for each API resource.

Status 200 application/json

Response Body:

{
    "apiResourceClonedFromId": null,
    "lockVersion": 18298372979,
    "apiResourceName": "cloud security",
    "apiResourceMethods": [
        {
            "apiParameters": [
                {
                    "clonedFromId": null,
                    "apiParameterRestriction": {
                        "rangeRestriction": {
                            "rangeMax": 15,
                            "rangeMin": 6
                        }
                    },
                    "apiParamLogicId": 32649,
                    "apiParameterRequired": true,
                    "apiParameterType": "integer",
                    "apiParameterName": "endpoint-id",
                    "apiParameterId": 9230,
                    "array": false,
                    "apiParameterLocation": "path",
                    "apiParameterNotes": null
                },
                {
                    "clonedFromId": null,
                    "apiParameterRestriction": null,
                    "apiParamLogicId": 32650,
                    "apiParameterRequired": true,
                    "apiParameterType": "string",
                    "apiParameterName": "resourceId",
                    "apiParameterId": 8793,
                    "array": false,
                    "apiParameterLocation": "path",
                    "apiParameterNotes": null
                }
            ],
            "clonedFromId": null,
            "apiResourceMethodId": 1902,
            "apiResourceMethodLogicId": 25615,
            "apiResourceMethod": "GET"
        }
    ],
    "resourcePath": "/resources/{resourceId}",
    "apiResourceLogicId": 14180,
    "updateDate": "2015-10-07T17:41:52+0000",
    "createdBy": "rsahk",
    "updatedBy": "rsahk",
    "createDate": "2013-10-07T17:41:52+0000",
    "apiResourceId": 12893,
    "description": "resource description"
}

Remove a Resource

Remove a resource from within an API endpoint service.

DELETE /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/resources/{apiResourceId}

Sample: /api-definitions/v2/endpoints/12892/versions/1/resources/7689

Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 12892 Unique integer identifier for each API endpoint service.
versionNumber Integer 1 A unique identifier for each API endpoint version.
apiResourceId Integer 7689 A unique Akamai integer identifier for each API resource.

Status 204

Get Cache Settings

Returns a configuration of cache settings for a specific endpoint version.

GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/cache

Sample: /api-definitions/v2/endpoints/288595/versions/23/settings/cache

Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 288595 Id of the endpoint
apiEndPointVersion Integer 23 Version of the settings for endpoint to get/update

Status 200 application/json

Response Body:

{
    "errorCaching": {
        "preserveStale": false,
        "enabled": false,
        "maxAge": null
    },
    "option": "CACHE",
    "serveStale": false,
    "enabled": true,
    "maxAge": {
        "duration": 123,
        "unit": "SECONDS"
    },
    "downstreamCaching": {
        "headers": "CACHE_CONTROL_AND_EXPIRES",
        "maxAge": null,
        "markAsPrivate": false,
        "option": "NOT_ALLOW_CACHING",
        "lifetime": "SMALLER_VALUE"
    },
    "resources": {
        "12084": {
            "path": "/2",
            "option": "BYPASS_CACHE",
            "maxAge": null,
            "serveStale": false,
            "methods": [
                "HEAD",
                "DELETE",
                "POST",
                "GET",
                "OPTIONS",
                "PUT",
                "PATCH"
            ]
        },
        "12083": {
            "path": "/1",
            "option": "CACHE",
            "maxAge": {
                "duration": 123,
                "unit": "SECONDS"
            },
            "serveStale": false,
            "methods": [
                "HEAD",
                "DELETE",
                "POST",
                "GET",
                "PUT"
            ]
        }
    }
}

Update Cache Settings

Updates a configuration of cache settings for a specific endpoint version.

PUT /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/cache

Sample: /api-definitions/v2/endpoints/288595/versions/23/settings/cache

Content-Type: application/json

Request Body:

{
    "errorCaching": {
        "preserveStale": false,
        "enabled": false,
        "maxAge": null
    },
    "option": "CACHE",
    "serveStale": false,
    "enabled": true,
    "maxAge": {
        "duration": 123,
        "unit": "SECONDS"
    },
    "downstreamCaching": {
        "headers": "CACHE_CONTROL_AND_EXPIRES",
        "maxAge": null,
        "markAsPrivate": false,
        "option": "NOT_ALLOW_CACHING",
        "lifetime": "SMALLER_VALUE"
    },
    "resources": {
        "12084": {
            "path": "/2",
            "option": "BYPASS_CACHE",
            "maxAge": null,
            "serveStale": false,
            "methods": [
                "HEAD",
                "DELETE",
                "POST",
                "GET",
                "OPTIONS",
                "PUT",
                "PATCH"
            ]
        },
        "12083": {
            "path": "/1",
            "option": "CACHE",
            "maxAge": {
                "duration": 123,
                "unit": "SECONDS"
            },
            "serveStale": false,
            "methods": [
                "HEAD",
                "DELETE",
                "POST",
                "GET",
                "PUT"
            ]
        }
    }
}
Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 288595 Id of the endpoint
apiEndPointVersion Integer 23 Version of the settings for endpoint to get/update

Status 200 application/json

Response Body:

{
    "errorCaching": {
        "preserveStale": false,
        "enabled": false,
        "maxAge": null
    },
    "option": "CACHE",
    "serveStale": false,
    "enabled": true,
    "maxAge": {
        "duration": 123,
        "unit": "SECONDS"
    },
    "downstreamCaching": {
        "headers": "CACHE_CONTROL_AND_EXPIRES",
        "maxAge": null,
        "markAsPrivate": false,
        "option": "NOT_ALLOW_CACHING",
        "lifetime": "SMALLER_VALUE"
    },
    "resources": {
        "12084": {
            "path": "/2",
            "option": "BYPASS_CACHE",
            "maxAge": null,
            "serveStale": false,
            "methods": [
                "HEAD",
                "DELETE",
                "POST",
                "GET",
                "OPTIONS",
                "PUT",
                "PATCH"
            ]
        },
        "12083": {
            "path": "/1",
            "option": "CACHE",
            "maxAge": {
                "duration": 123,
                "unit": "SECONDS"
            },
            "serveStale": false,
            "methods": [
                "HEAD",
                "DELETE",
                "POST",
                "GET",
                "PUT"
            ]
        }
    }
}

Get GZIP Settings

Returns a configuration of Gzip settings for a specific endpoint version.

GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/gzip

Sample: /api-definitions/v2/endpoints/288595/versions/23/settings/gzip

Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 288595 Id of the endpoint
apiEndPointVersion Integer 23 Version of the settings for endpoint to get/update

Status 200 application/json

Response Body:

{
    "compressResponse": "ALWAYS"
}

Update GZIP Settings

Updates a configuration of Gzip settings for a specific endpoint.

PUT /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/gzip

Sample: /api-definitions/v2/endpoints/288595/versions/23/settings/gzip

Content-Type: application/json

Request Body:

{
    "compressResponse": "ALWAYS"
}
Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 288595 Id of the endpoint
apiEndPointVersion Integer 23 Version of the settings for endpoint to get/update

Status 200 application/json

Response Body:

{
    "compressResponse": "ALWAYS"
}

Update CORS Settings

Returns a configuration of CORS settings for a specific endpoint version.

GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/cors

Sample: /api-definitions/v2/endpoints/288595/versions/23/settings/cors

Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 288595 Id of the endpoint
apiEndPointVersion Integer 23 Version of the settings for endpoint to get/update

Status 200 application/json

Response Body:

{
    "allowedHeaders": [
        "Akamai-Cors-Allowed"
    ],
    "enabled": true,
    "allowCredentials": false,
    "exposedHeaders": [
        "Akamai-Cors-Exposed"
    ],
    "allowedMethods": [
        "GET"
    ],
    "preflightMaxAge": 86400,
    "allowedOrigins": [
        "*"
    ]
}

Get CORS Settings

Updates a configuration of CORS settings for a specific endpoint version.

PUT /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/cors

Sample: /api-definitions/v2/endpoints/288595/versions/23/settings/cors

Content-Type: application/json

Request Body:

{
    "allowedHeaders": [
        "Akamai-Cors-Allowed"
    ],
    "enabled": true,
    "allowCredentials": false,
    "exposedHeaders": [
        "Akamai-Cors-Exposed"
    ],
    "allowedMethods": [
        "GET"
    ],
    "preflightMaxAge": 86400,
    "allowedOrigins": [
        "*"
    ]
}
Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 288595 Id of the endpoint
apiEndPointVersion Integer 23 Version of the settings for endpoint to get/update

Status 200 application/json

Response Body:

{
    "allowedHeaders": [
        "Akamai-Cors-Allowed"
    ],
    "enabled": true,
    "allowCredentials": false,
    "exposedHeaders": [
        "Akamai-Cors-Exposed"
    ],
    "allowedMethods": [
        "GET"
    ],
    "preflightMaxAge": 86400,
    "allowedOrigins": [
        "*"
    ]
}

Get JWT Settings

Returns a configuration of JWT settings for a specific endpoint version.

GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/jwt

Sample: /api-definitions/v2/endpoints/288595/versions/23/settings/jwt

Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 288595 Id of the endpoint
apiEndPointVersion Integer 23 Version of the settings for endpoint to get/update

Status 200 application/json

Response Body:

{
    "enabled": true,
    "resources": {
        "11903": {
            "path": "/endpoint2",
            "notes": null,
            "enabled": false,
            "methods": [
                "HEAD",
                "DELETE",
                "POST",
                "GET",
                "OPTIONS",
                "PUT",
                "PATCH"
            ]
        },
        "11904": {
            "path": "/endpoint1",
            "notes": null,
            "enabled": true,
            "methods": [
                "HEAD",
                "DELETE",
                "POST",
                "GET",
                "OPTIONS",
                "PUT",
                "PATCH"
            ]
        }
    },
    "settings": {
        "paramName": "cookieWT",
        "validation": {
            "claims": [
                {
                    "validate": true,
                    "required": false,
                    "type": "ARRAY",
                    "name": "aud",
                    "value": [
                        "ala"
                    ]
                },
                {
                    "validate": true,
                    "required": true,
                    "type": "STRING",
                    "name": "iss",
                    "value": "kot"
                },
                {
                    "validate": true,
                    "required": false,
                    "type": "STRING",
                    "name": "sub",
                    "value": "kozak"
                },
                {
                    "validate": false,
                    "required": false,
                    "type": "TIMESTAMP",
                    "name": "exp",
                    "value": null
                },
                {
                    "validate": false,
                    "required": false,
                    "type": "TIMESTAMP",
                    "name": "nbf",
                    "value": null
                }
            ],
            "rsaPublicKeyB": null,
            "rsaPublicKeyA": {
                "content": "-----BEGIN PUBLIC KEY-----\nMIIBIjwE9GQg+OR0WYHtq4AKsvK2eucDs06ejWRDb+uDN\n80jxZCxfweelZKvYT9Qdms/1SJv\nrQIDAQAB\n-----END PUBLIC KEY-----\n",
                "name": "id_rsa-2.pub"
            }
        },
        "clockSkew": 0,
        "location": "COOKIE"
    }
}

Update JWT Settings

Updates a configuration of JWT settings for a specific endpoint version.

PUT /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/jwt

Sample: /api-definitions/v2/endpoints/288595/versions/23/settings/jwt

Content-Type: application/json

Request Body:

{
    "enabled": true,
    "resources": {
        "11903": {
            "path": "/endpoint2",
            "notes": null,
            "enabled": false,
            "methods": [
                "HEAD",
                "DELETE",
                "POST",
                "GET",
                "OPTIONS",
                "PUT",
                "PATCH"
            ]
        },
        "11904": {
            "path": "/endpoint1",
            "notes": null,
            "enabled": true,
            "methods": [
                "HEAD",
                "DELETE",
                "POST",
                "GET",
                "OPTIONS",
                "PUT",
                "PATCH"
            ]
        }
    },
    "settings": {
        "paramName": "cookieWT",
        "validation": {
            "claims": [
                {
                    "validate": true,
                    "required": false,
                    "type": "ARRAY",
                    "name": "aud",
                    "value": [
                        "ala"
                    ]
                },
                {
                    "validate": true,
                    "required": true,
                    "type": "STRING",
                    "name": "iss",
                    "value": "kot"
                },
                {
                    "validate": true,
                    "required": false,
                    "type": "STRING",
                    "name": "sub",
                    "value": "kozak"
                },
                {
                    "validate": false,
                    "required": false,
                    "type": "TIMESTAMP",
                    "name": "exp",
                    "value": null
                },
                {
                    "validate": false,
                    "required": false,
                    "type": "TIMESTAMP",
                    "name": "nbf",
                    "value": null
                }
            ],
            "rsaPublicKeyB": null,
            "rsaPublicKeyA": {
                "content": "-----BEGIN PUBLIC KEY-----\nMIIBIjwE9GQg+OR0WYHtq4AKsvK2eucDs06ejWRDb+uDN\n80jxZCxfweelZKvYT9Qdms/1SJv\nrQIDAQAB\n-----END PUBLIC KEY-----\n",
                "name": "id_rsa-2.pub"
            }
        },
        "clockSkew": 0,
        "location": "COOKIE"
    }
}
Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 288595 Id of the endpoint
apiEndPointVersion Integer 23 Version of the settings for endpoint to get/update

Status 200 application/json

Response Body:

{
    "enabled": true,
    "resources": {
        "11903": {
            "path": "/endpoint2",
            "notes": null,
            "enabled": false,
            "methods": [
                "HEAD",
                "DELETE",
                "POST",
                "GET",
                "OPTIONS",
                "PUT",
                "PATCH"
            ]
        },
        "11904": {
            "path": "/endpoint1",
            "notes": null,
            "enabled": true,
            "methods": [
                "HEAD",
                "DELETE",
                "POST",
                "GET",
                "OPTIONS",
                "PUT",
                "PATCH"
            ]
        }
    },
    "settings": {
        "paramName": "cookieWT",
        "validation": {
            "claims": [
                {
                    "validate": true,
                    "required": false,
                    "type": "ARRAY",
                    "name": "aud",
                    "value": [
                        "ala"
                    ]
                },
                {
                    "validate": true,
                    "required": true,
                    "type": "STRING",
                    "name": "iss",
                    "value": "kot"
                },
                {
                    "validate": true,
                    "required": false,
                    "type": "STRING",
                    "name": "sub",
                    "value": "kozak"
                },
                {
                    "validate": false,
                    "required": false,
                    "type": "TIMESTAMP",
                    "name": "exp",
                    "value": null
                },
                {
                    "validate": false,
                    "required": false,
                    "type": "TIMESTAMP",
                    "name": "nbf",
                    "value": null
                }
            ],
            "rsaPublicKeyB": null,
            "rsaPublicKeyA": {
                "content": "-----BEGIN PUBLIC KEY-----\nMIIBIjwE9GQg+OR0WYHtq4AKsvK2eucDs06ejWRDb+uDN\n80jxZCxfweelZKvYT9Qdms/1SJv\nrQIDAQAB\n-----END PUBLIC KEY-----\n",
                "name": "id_rsa-2.pub"
            }
        },
        "clockSkew": 0,
        "location": "COOKIE"
    }
}

Get API Privacy Settings

Returns a configuration of API privacy settings for a specific endpoint version.

GET /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/api-privacy

Sample: /api-definitions/v2/endpoints/288595/versions/23/settings/api-privacy

Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 288595 Id of the endpoint
apiEndPointVersion Integer 23 Version of the settings for endpoint to get/update

Status 200 application/json

Response Body:

{
    "resources": {
        "6362": {
            "path": "/add",
            "notes": "Public resource with all methods",
            "methods": [
                "HEAD",
                "DELETE",
                "POST",
                "GET",
                "OPTIONS",
                "PUT",
                "PATCH"
            ],
            "public": true
        }
    },
    "private": true
}

Update API Privacy Settings

Updates a configuration of cache settings for a specific endpoint version.

PUT /api-definitions/v2/endpoints/{apiEndPointId}/versions/{apiEndPointVersion}/settings/api-privacy

Sample: /api-definitions/v2/endpoints/288595/versions/23/settings/api-privacy

Content-Type: application/json

Request Body:

{
    "resources": {
        "6362": {
            "path": "/add",
            "notes": "Public resource with all methods",
            "methods": [
                "HEAD",
                "DELETE",
                "POST",
                "GET",
                "OPTIONS",
                "PUT",
                "PATCH"
            ],
            "public": true
        }
    },
    "private": true
}
Parameter Type Sample Description
URL Parameters
apiEndPointId Integer 288595 Id of the endpoint
apiEndPointVersion Integer 23 Version of the settings for endpoint to get/update

Status 200 application/json

Response Body:

{
    "resources": {
        "6362": {
            "path": "/add",
            "notes": "Public resource with all methods",
            "methods": [
                "HEAD",
                "DELETE",
                "POST",
                "GET",
                "OPTIONS",
                "PUT",
                "PATCH"
            ],
            "public": true
        }
    },
    "private": true
}

Last modified: 11/22/2017