API
Start typing to search…

Clone a version

post https://{hostname}/api-definitions/v2/endpoints//versions//cloneVersion

Creates a new endpoint version as a clone of an existing version. The system assigns a new number to the version that you clone.

Path Params
integer
required

The unique identifier for the endpoint version.

integer
required

The unique identifier for the endpoint.

Query Params
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.

Responses

Response body
object
object | null

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.

integer

Whether the API allows requests on undefined resources, but only for specific methods. Either 1 or 0 for yes or no.

1

integer

Whether the API allows for requests with undefined parameters in body. Either 1 or 0 for yes or no.

1

integer

Whether the API allows for requests with undefined parameters in cookies. These booleans override members in the Method object. Either 1 or 0 for yes or no.

1

integer

Whether the API allows for requests with undefined parameters in header. Either 1 or 0 for yes or no.

1

integer

Whether the API allows requests on undefined resources using the DELETE method. Either 1 or 0 for yes or no.

1

integer

Whether the API allows requests on undefined resources using the GET method. Either 1 or 0 for yes or no.

1

integer

Whether the API allows requesting undefined resources using HEAD method. Either 1 or 0 for yes or no.

1

integer

Whether the API allows requesting undefined resources using OPTIONS method. Either 1 or 0 for yes or no.

1

integer

Whether the API allows requesting undefined resources using PATCH method. Either 1 or 0 for yes or no.

1

integer

Whether the API allows requests on undefined resources using the POST method. Either 1 or 0 for yes or no.

1

integer

Whether the API allows requests on undefined resources using the PUT method. Either 1 or 0 for yes or no.

1

integer

Whether the API allows requesting with undefined parameters. Either 1 or 0 for yes or no.

1

integer

Whether the API allows for requests with undefined parameters in query string. Either 1 or 0 for yes or no.

1

integer

Whether the API allows requests on undefined resources. Either 1 or 0 for yes or no.

1

integer

Whether the API allows requesting undefined resources, but only for specific locations. Either 1 or 0 for yes or no.

1

integer | null

The maximum allowed size of a request body.

integer | null

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

integer | null

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

integer | null

The maximum integer value allowed in a request body.

integer | null

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

integer | null

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

integer

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

1

integer | null

Whether to create the API with API Protection 2 or above. Either 1, 2 for enabled API Protection 2, or null for the legacy API.

1 2

integer

When set to 1, the API allows for responses with undefined parameters in the response body. Otherwise the value is 0.

1

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
length ≥ 1

The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.

apiEndPointHosts*
integer | null

Read-only The unique identifier for the endpoint.

boolean | null

Read-only Whether the endpoint version is read-only.

string
required

The name of the endpoint, unique within the account.

string | null

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

http https http/https

integer | null

Read-only The unique identifier for the endpoint version.

boolean | null
Defaults to true

Whether the API Gateway product should be enabled for the endpoint. If null, the member is set to true.

array of objects | null

Resources assigned to the endpoint.

apiResources
object
integer | null

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

integer

The unique identifier for the resource.

integer

The unique identifier for the resource across all endpoint versions.

apiResourceMethodNameLists
array of strings

HTTP methods the resource may respond to.

apiResourceMethodNameLists
apiResourceMethods
array of objects

HTTP methods the resource may respond to.

apiResourceMethods
object
array of objects | null

Parameter objects assigned to the method.

apiParameters
object
apiChildParameters
array of objects

Child JSON members or XML elements for JSON or XML body type parameters.

apiChildParameters
object
integer

Read-only The unique identifier for the parameter across all endpoint versions.

string

The content type of the parameter, either json, xml, json/xml for either, urlencoded, any, or none. Only applicable for top-level body parameters.

json xml json/xml urlencoded any none

integer

Read-only The unique identifier for the parameter.

string
required

The location of the parameter in an HTTP request, either query, header, path, cookie, or body for a JSON or XML body type parameter.

query header path cookie body

string
required

The name of the parameter. If the corresponding apiParameterLocation is path, ensure that this value matches the parameter name you specified in the resourcePath.

string | null

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

boolean
required

Specifies whether the API user needs to specify the parameter. If the corresponding apiParameterLocation is path, set this member to true.

object | null

Restrictions and XML representation rules specified for the parameter.

string
required

The data type of the parameter, either string, integer, number, boolean, or json/xml for JSON or XML objects.

string integer number boolean json/xml

integer | null

Read-only The unique identifier for the parameter's parent method.

boolean

Whether the parameter can express more than one value. This member is only applicable for apiChildParameters that you can specify if the corresponding apiParameterLocation is body and the apiParameterType is json/xml. If you enable this, also define the arrayRestriction member.

integer | null

The index of a segment that includes a path parameter in a resource path. For example, given a path \books\{bookId}, the books segment has index 0, and the path parameter {bookId} has index 1.

boolean

Whether the parameter is within a response type.

string
required

The core HTTP method to which the resource may respond, either GET, PUT, POST, DELETE, HEAD, PATCH, or OPTIONS.

GET PUT POST DELETE HEAD PATCH OPTIONS

integer | null

Read-only The unique identifier for the resource's allowed method.

integer | null

Read-only The unique identifier for the resource's method across all endpoint versions.

string
required

The name of the resource.

date-time

The ISO 8601 timestamp indicating when you created the resource.

string

The identifier for the user who created the resource.

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.

string | null

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

integer

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

boolean

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

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.

date-time

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

string

The identifier for the user who last modified the resource.

string | null

Specifies if the API's data comes from API_DISCOVERY or was provided by the USER.

API_DISCOVERY USER

object | null

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

string
required

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

HEADER BASE_PATH QUERY

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.

string

The expected API version value in an incoming request.

array of strings | null

Read-only Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see Endpoint.availableActions values.

availableActions
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.

boolean | null

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

integer | null

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

string | null

The content type the endpoint exchanges, either json, xml, urlencoded, json/xml/urlencoded, json/urlencoded, json/xml, or xml/urlencoded for multi-format APIs, any, or none. A null value is the same as a none string.

json xml urlencoded json/xml/urlencoded json/urlencoded json/xml xml/urlencoded any none

string | null
required

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

date-time | null

Read-only The ISO 8601 timestamp indicating when you created the endpoint.

string | null

Read-only The identifier for the user who created the endpoint.

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.

array of integers | null

Personally identifiable information (PII) in your API parameters discovered by the network.

discoveredPiiIds
boolean | null

Read-only Specifies 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.

integer | null
required

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

boolean

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

integer
required

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

boolean | null
Defaults to true

Whether or not to include path segment parameters in match criteria, like the jsessionid portion of /ssocookie;jsessionid=434343.

boolean | null

Specifies whether the KSD firewall policies are enabled for the endpoint.

string | null

Read-only 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 was once active but is now inactive, 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

object | null

Read-only An endpoint version's activation status on the production network.

object | null

The last failed activation of the endpoint version.

string | null

Read-only The 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

date-time | null

Read-only The ISO 8601 timestamp indicating the last update of the activation status.

integer | null

Read-only The endpoint version number.

boolean

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

boolean | null

Read-only Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.

object | null

The key with which users may access the endpoint.

securitySchemeDetail
object

The location of the API key.

string

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

apikey

object | null

Read-only The import file used to create the endpoint.

string | null

Read-only The major version of the API defined in the import file.

string | null

Read-only The version of the import file's specification.

string | null

Read-only The specification of the import file you uploaded to create the endpoint version. Either SWAGGER or RAML.

SWAGGER RAML

string | null

Read-only 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 was once active but is now inactive, 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

object | null

Read-only An endpoint version's activation status on the staging network.

object | null

The last failed activation of the endpoint version.

string | null

Read-only The 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

date-time | null

Read-only The ISO 8601 timestamp indicating the last update of the activation status.

integer | null

Read-only The endpoint version number.

date-time | null

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

string | null

Read-only The identifier for the user who last modified the endpoint.

boolean | null

Read-only Specifies 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.

integer | null

The endpoint version number.

Updated 6 months ago

Did this page help you?
Language
URL

Updated 6 months ago

Did this page help you?