Create an endpoint or resource

post https://{hostname}/appsec/v1/api-discovery/host/{hostname}/basepath/{basePath}/endpoints

Create a new API endpoint or add a resource to an existing endpoint. When you run this operation to add a new resource to an existing API, the API version is cloned for you and the resource is included in the new version.

Path Params

hostname

string

required

The base64-encoded value of the hostname.

basePath

string

required

The base64-encoded value of the base path.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

apiEndpointId

integer

A unique identifier for an API endpoint. You need this when adding a resource to an existing endpoint.

apiName

string

The name for this API endpoint. You need this to register an endpoint.

contractId

string

A unique identifier for a contract. You need this when registering a new endpoint.

groupId

integer

A unique identifier for a group. You need this when registering a new endpoint.

version

integer

The version number. You need this when adding a resource to an existing endpoint. When a version is read-only, the version is cloned and updates are included in the newly cloned version.

Responses

Response body

object

akamaiSecurityRestrictions

object | null

Contains information about the Kona Site Defender security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a Kona Site Defender customer.

ALLOW_UNDEFINED_RESPONSE_BODY_PARAMS

integer

When set to 1, the API allows for responses with undefined parameters in the response body. When 0, the API does not allow responses with undefined parameters in the response body.

1

ALLOW_UNDEFINED_RESPONSE_HEADER_PARAMS

integer

When set to 1, the API allows for responses with undefined parameters in the response header. When set to 0, the API does not allow responses with undefined parameters in the response header.

1

MAX_BODY_SIZE

integer

The maximum allowed size of a request body.

MAX_DOC_DEPTH

integer

The maximum depth of nested data elements allowed in a request body.

MAX_ELEMENT_NAME_LENGTH

integer

The maximum length of an XML element name or JSON object key name allowed in a request body.

MAX_INTEGER_VALUE

integer

The maximum integer value allowed in a request body.

MAX_JSONXML_ELEMENT

integer

The maximum number of XML elements, JSON object keys, or array items allowed in a request body.

MAX_STRING_LENGTH

integer

The maximum length of any string value in a request body.

POSITIVE_SECURITY_ENABLED

integer

Whether the API request body and resource constraints should be enforced as allowlists in your KSD security policies. Either 1 for enabled security constraints, or 0 for disabled.

1

apiCategoryIds

array of integers | null

The category identifiers that apply to the endpoint. The value is null for uncategorized endpoints.

apiCategoryIds

apiEndPointHosts

array of strings

required

The hostnames that may receive traffic for the endpoint. At least one hostname is required before activating the endpoint.

apiEndPointHosts*

apiEndPointId

integer

The unique identifier for the endpoint.

apiEndPointLocked

boolean

Whether the endpoint version is read-only.

apiEndPointName

string

required

The name of the endpoint, unique within the account.

apiEndPointScheme

string

The URL scheme to which the endpoint may respond, either http, https, or http/https for both.

http https http/https

apiEndPointVersion

integer

The unique identifier for the endpoint version.

apiResources

array of objects

The list of resource objects associated with the endpoint.

apiResources

object

apiResourceClonedFromId

integer | null

For cloned resources, the unique identifier for the source resource.

apiResourceId

integer

The unique identifier for the resource.

apiResourceLogicId

integer

The unique identifier for the resource across all endpoint versions.

apiResourceMethodNameLists

array of strings

The list of HTTP methods the resource may respond to.

apiResourceMethodNameLists

apiResourceMethods

array of objects

The list of Method objects that represent HTTP methods the resource may respond to.

apiResourceMethods

object

apiResourceClonedFromId

integer | null

For cloned resources, the unique identifier for the source resource.

apiResourceId

integer

The unique identifier for the resource.

apiResourceLogicId

integer

The unique identifier for the resource across all endpoint versions.

apiResourceMethodNameLists

array of strings

The list of HTTP methods the resource may respond to.

apiResourceMethodNameLists

apiResourceMethods

array of objects

The list of Method objects that represent HTTP methods the resource may respond to.

apiResourceMethods

object

apiResourceClonedFromId

integer | null

For cloned resources, the unique identifier for the source resource.

apiResourceId

integer

The unique identifier for the resource.

apiResourceLogicId

integer

The unique identifier for the resource across all endpoint versions.

apiResourceMethodNameLists

array of strings

The list of HTTP methods the resource may respond to.

apiResourceMethodNameLists

apiResourceMethods

array of objects

Nested methods.

apiResourceMethods

object

apiResourceName

string

required

The name of the resource.

createDate

date-time

The ISO 8601 timestamp indicating when you created the resource.

createdBy

string

The identifier for the user who created the resource.

description

string | null

The description to clarify the resource's function within the API. If you specify null in the request or omit this member from the object, the JSON response reflects it as an empty string.

link

string | null

The location of the navigable resource within this API, for use by API clients.

lockVersion

integer

The identifier used for optimistic locking. See Concurrency control for details.

private

boolean

Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.

resourcePath

string

required

The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets ({}) to define path parameters (for example, /path/{pathparam}). If you decide to do so, ensure that the value of the apiParameterName member in the corresponding parameter definition matches the name that you specified in the resource path.

updateDate

date-time

The ISO 8601 timestamp indicating when you last modified the resource.

updatedBy

string

The identifier for the user who last modified the resource.

apiResourceName

string

required

The name of the resource.

createDate

date-time

The ISO 8601 timestamp indicating when you created the resource.

createdBy

string

The identifier for the user who created the resource.

description

string | null

The description to clarify the resource's function within the API. If you specify null in the request or omit this member from the object, the JSON response reflects it as an empty string.

link

string | null

The location of the navigable resource within this API, for use by API clients.

lockVersion

integer

The identifier used for optimistic locking. See Concurrency control for details.

private

boolean

Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.

resourcePath

string

required

updateDate

date-time

The ISO 8601 timestamp indicating when you last modified the resource.

updatedBy

string

The identifier for the user who last modified the resource.

apiResourceName

string

required

The name of the resource.

createDate

date-time

The ISO 8601 timestamp indicating when you created the resource.

createdBy

string

The identifier for the user who created the resource.

description

string | null

The description to clarify the resource's function within the API. If you specify null in the request or omit this member from the object, the JSON response reflects it as an empty string.

link

string | null

The location of the navigable resource within this API, for use by API clients.

lockVersion

integer

The identifier used for optimistic locking. See Concurrency control for details.

private

boolean

Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.

resourcePath

string

required

updateDate

date-time

The ISO 8601 timestamp indicating when you last modified the resource.

updatedBy

string

The identifier for the user who last modified the resource.

apiVersionInfo

object | null

Contains information about a major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.

location

string

required

The location of the API version value in an incoming request. Either HEADER, BASE_PATH, or QUERY parameter.

HEADER BASE_PATH QUERY

parameterName

string

The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding location member is either HEADER or QUERY.

value

string

The expected API version value in an incoming request.

availableActions

array of strings

The collection of available actions that you can perform on the endpoint depending on its versions' activation status.

availableActions

basePath

string | null

The URL path that serves as a root prefix for all resources' resourcePath values. This is / if empty. Don't append a / character to the path. If you specify null in the request or omit this member from the object, the JSON response reflects it as an empty string.

caseSensitive

boolean

Whether the URLs and parameters within the endpoint are case sensitive.

clonedFromVersion

integer | null

For cloned endpoints, the unique identifier for the source endpoint version.

consumeType

string

The content type the endpoint exchanges, either json, xml, json/xml for dual-format APIs, any, or none.

json xml json/xml any none

contractId

string

The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.

createDate

string

The ISO 8601 timestamp indicating when you created the endpoint.

createdBy

string

The identifier for the user who created the endpoint.

description

string | null

The description of the endpoint. If you specify null in the request or omit this member from the object, the JSON response reflects it as an empty string.

endpointHidden

boolean

Whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the Show an endpoint operation.

groupId

integer

The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.

isGraphQL

boolean

Whether the endpoint uses GraphQL to deliver structured content to clients.

lockVersion

integer

The identifier for the last modification of an endpoint version, used for optimistic locking. See Concurrency control for details.

positiveConstrainsEnabled

boolean | null

Whether the KSD firewall policies are enabled for the endpoint.

productionStatus

string | null

The version activation status on the production network, either PENDING if the version contains changes that are being propagated to the network, ACTIVE if the version is active, DEACTIVATED if the version had been active once but has been deactivated, or FAILED if an activation or deactivation attempt for this version has failed. The value is null for versions that have never been activated on this network.

PENDING ACTIVE DEACTIVATED FAILED

productionVersion

object

Contains information about an endpoint version's activation status on the production network.

Has additional fields

protectedByApiKey

boolean

Whether you enabled API key protection for the endpoint version by making the version private.

securityScheme

object

Contains information about the key with which users may access the endpoint.

securitySchemeDetail

object

Contains information about the location of the API key.

securitySchemeType

string

The type of security scheme implemented for the endpoint. The only valid value is apikey.

apikey

source

object | null

Contains information about the import file used to create the endpoint.

Has additional fields

stagingStatus

string | null

The version activation status on the staging network, either PENDING if the version contains changes that are being propagated to the network, ACTIVE if the version is active, DEACTIVATED if the version had been active once but has been deactivated, or FAILED if an activation or deactivation attempt for this version has failed. The value is null for versions that have never been activated on this network.

PENDING ACTIVE DEACTIVATED FAILED

stagingVersion

object

Contains information about an endpoint version's activation status on the staging network.

Has additional fields

updateDate

string

The ISO 8601 timestamp indicating when you last modified the endpoint.

updatedBy

string

The identifier for the user who last modified the endpoint.

versionHidden

boolean

Whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the Show a version operation.

versionNumber

integer

The endpoint version number.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://hostname/appsec/v1/api-discovery/host/hostname/basepath/basePath/endpoints \
# Add Authorization header to this snippet
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
136
}
1
{
2
  "akamaiSecurityRestrictions": null,
3
  "apiCategoryIds": [
4
    2,
5
    7
6
  ],
7
  "apiEndPointHosts": [
8
    "bookstore.api.akamai.com"
9
  ],
10
  "apiEndPointId": 492375,
11
  "apiEndPointLocked": false,
12
  "apiEndPointName": "Bookstore API",
13
  "apiEndPointScheme": "http/https",
14
  "apiEndPointVersion": 574127,
15
  "apiResources": [
16
    {
17
      "apiResourceClonedFromId": null,
18
      "apiResourceId": 2926712,
19
      "apiResourceLogicId": 118435,
20
      "apiResourceMethods": [
21
        {
22
          "apiParameters": [
23
            {
24
              "apiChildParameters": [],
25
              "apiParamLogicId": 578116,

201Successfully registered an endpoint or a new resource to an existing endpoint.

400Invalid. Client error, such as invalid or malformed input.

403Forbidden. You don't have permission to write to this resource.

404Not found. The named security policy doesn't exist, doesn't carry application layer controls, or no rule with this ID is available for use in this policy.

500Internal server error. Something went wrong on our side. Try again in a few minutes, and contact support if the error persists.