--- updatedAt: 2026-03-01T18:09:30.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/api-definitions/llms.txt --- # Clone a version Creates a new endpoint version as a clone of an existing version. The system assigns a new number to the version that you clone. # OpenAPI definition ```json { "externalDocs": { "description": "See documentation for Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference" }, "info": { "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "API endpoints", "version": "v2" }, "openapi": "3.0.0", "paths": { "/endpoints/{apiEndPointId}/versions/{versionNumber}/cloneVersion": { "post": { "description": "Creates a new endpoint version as a clone of an existing version. The system assigns a new number to the version that you clone.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-clone" }, "operationId": "post-endpoint-version-clone", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "akamaiSecurityRestrictions": null, "apiCategoryIds": [ 2, 7 ], "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": 492375, "apiEndPointLocked": false, "apiEndPointName": "Bookstore API Premium", "apiEndPointScheme": "http/https", "apiEndPointVersion": 574127, "apiResources": [ { "apiResourceClonedFromId": null, "apiResourceId": 2926712, "apiResourceLogicId": 118435, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578116, "apiParameterId": 1212945, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 494448, "array": false, "pathParamLocationId": null } ], "apiResourceMethod": "GET", "apiResourceMethodId": 341591, "apiResourceMethodLogicId": 184404 }, { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578117, "apiParameterContentType": "json", "apiParameterId": 1212946, "apiParameterLocation": "body", "apiParameterName": "books", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": { "arrayRestriction": null, "lengthRestriction": { "lengthMax": 15, "lengthMin": 3 }, "numberRangeRestriction": null, "rangeRestriction": null, "xmlConversionRule": null }, "apiParameterType": "string", "apiResourceMethParamId": 494449, "array": true, "pathParamLocationId": null } ], "apiResourceMethod": "POST", "apiResourceMethodId": 341592, "apiResourceMethodLogicId": 184405 } ], "apiResourceName": "books", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "A book item within the bookstore API.", "link": null, "lockVersion": 2, "private": false, "resourcePath": "/books/{bookId}", "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin" } ], "availableActions": [ "DELETE", "CLONE_ENDPOINT", "ACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING" ], "basePath": "/bookstore-premium", "caseSensitive": true, "clonedFromVersion": 1, "consumeType": "any", "contractId": "C-0N7RAC71", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "endpointHidden": false, "groupId": 12345, "isGraphQL": false, "lockVersion": 2, "positiveConstrainsEnabled": null, "productionStatus": null, "productionVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "protectedByApiKey": true, "securityScheme": { "securitySchemeDetail": { "apiKeyLocation": "header", "apiKeyName": "apikey" }, "securitySchemeType": "apikey" }, "source": null, "stagingStatus": null, "stagingVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin", "versionHidden": false, "versionNumber": 2 }, "schema": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "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.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "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.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the member is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "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`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "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.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "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.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "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.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__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](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__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.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__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.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__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.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__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.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__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.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__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.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__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.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__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](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "required": [ "type", "instance" ], "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "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.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "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.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "required": [ "type", "instance" ], "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "required": [ "type", "instance" ], "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON members or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "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`.", "nullable": true, "type": "string" }, "apiParameterRequired": { "description": "Specifies whether the API user needs to specify the parameter. If the corresponding `apiParameterLocation` is `path`, set this member to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` member.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "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.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "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`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "required": [ "type", "instance" ], "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An endpoint and its associated resources.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-response.yaml" } } } }, "description": "Updated API Endpoint." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have access to the endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "detail": "Conflict with current state of resource.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 409, "title": "Conflict", "type": "/api-definitions/error-types/conflict" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/api-definitions/reference/409).", "x-akamai": { "file-path": "errors/409.yaml" } } }, "summary": "Clone a version", "tags": [ "Versions" ] }, "parameters": [ { "description": "The unique identifier for the endpoint version.", "in": "path", "name": "versionNumber", "required": true, "schema": { "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/version-number-path.yaml" } }, { "description": "The unique identifier for the endpoint.", "in": "path", "name": "apiEndPointId", "required": true, "schema": { "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/clone-version.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/cloneVersion" } } }, "servers": [ { "url": "https://{hostname}/api-definitions/v2" } ], "x-akamai": { "auth-type": "EDGE_GRID", "file-path": "03-api-endpoint-resource.yaml" }, "x-readme": { "samples-languages": [ "curl", "python", "node" ], "explorer-enabled": true, "proxy-enabled": true } } ``` # Sibling pages * [List versions](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-versions.md) * [Get a version summary](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version.md) * [Edit a version](https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version.md) * [Delete a version](https://techdocs.akamai.com/api-definitions/reference/delete-endpoint-version.md) * [Activate a version](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-activate.md) * [Deactivate a version](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-deactivate.md) * [Edit an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-file.md) * [Hide a version](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-hide.md) * [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show.md)