openapi: 3.0.0 info: title: 'Akamai: API Endpoint Definition Access tokens Versions API' version: '2' license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://{hostname}/api-definitions/v2 tags: - name: Versions paths: /endpoints/{apiEndPointId}/versions: parameters: - description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' in: path name: apiEndPointId required: true schema: example: 1 type: integer x-akamai: file-path: parameters/apiEndPointId-path.yaml get: description: Returns versions of an endpoint, with results optionally paginated, sorted, and filtered. operationId: get-endpoint-versions summary: List versions tags: - Versions externalDocs: description: See documentation for this operation in Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference/get-endpoint-versions responses: '200': description: Lists API endpoint versions you have access to in this account. content: application/json: example: apiEndPointId: 492375 apiEndPointName: Bookstore API page: 1 pageSize: 25 totalSize: 50 apiVersions: - apiEndPointVersionId: 599104 basePath: /bookstore2 basedOn: 1 createDate: 2019-06-17T07:22:29+0000 createdBy: mrossi description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. hidden: false isVersionLocked: false lockVersion: 2 productionDate: null productionStatus: null stagingDate: null stagingStatus: null updateDate: 2019-06-17T07:23:11+0000 updatedBy: bookstore_admin versionNumber: 2 availableActions: - ACTIVATE_ON_PRODUCTION - VIEW_AAG_SETTINGS - COMPARE_RAPID_SETTINGS - EDIT_AAG_SETTINGS - HIDE_VERSION - CLONE_VERSION - EDIT_ENDPOINT_DEFINITION - COMPARE_ENDPOINT - RESOURCES - ACTIVATE_ON_STAGING - DELETE - apiEndPointVersionId: 574127 basePath: /bookstore basedOn: null createDate: 2019-06-12T13:06:52+0000 createdBy: szhang description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. hidden: false isVersionLocked: false lockVersion: 0 productionDate: null productionStatus: null stagingDate: null stagingStatus: null updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin versionNumber: 1 availableActions: - VIEW_AAG_SETTINGS - EDIT_AAG_SETTINGS - EDIT_ENDPOINT_DEFINITION - DELETE - ACTIVATE_ON_STAGING - COMPARE_RAPID_SETTINGS - ACTIVATE_ON_PRODUCTION - COMPARE_ENDPOINT - CLONE_VERSION - RESOURCES - HIDE_VERSION schema: additionalProperties: false description: Contains information about all versions of an endpoint. type: object required: - apiEndpointId properties: apiEndPointId: description: The unique identifier for the endpoint. type: integer apiEndPointName: description: The name of the endpoint, unique within the account. type: string apiVersions: description: Contains information about each endpoint version within a collection. type: array items: additionalProperties: false type: object required: - lockVersion - versionNumber properties: apiEndPointVersionId: description: The unique identifier for the endpoint version. type: integer availableActions: description: The collection of available actions that you can perform on the version depending on the version's activation status. type: array items: type: string enum: - CLONE_ENDPOINT - CLONE_VERSION - DELETE - RESOURCES - COMPARE_ENDPOINT - COMPARE_AAG_SETTINGS - COMPARE_RESOURCE_PURPOSES - COMPARE_RAPID_SETTINGS - VIEW_AAG_SETTINGS - EDIT_AAG_SETTINGS - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING - ACTIVATE_ON_PRODUCTION - DEACTIVATE_ON_STAGING - DEACTIVATE_ON_PRODUCTION - HIDE_VERSION - SHOW_VERSION 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. type: string basedOn: description: For cloned versions, the unique identifier for the source version. nullable: true type: integer createDate: description: The ISO 6801 timestamp indicating when you created the endpoint version. format: date-time type: string createdBy: description: The identifier for the user who created the version. type: string description: description: The description of the endpoint version. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. type: string hidden: description: Indicates 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. type: boolean isVersionLocked: description: Whether the endpoint version is read-only. type: boolean lockVersion: description: 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. type: integer productionDate: description: The ISO 6801 timestamp indicating when you activated the endpoint version on the production network. format: date-time nullable: true type: string productionStatus: description: 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 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. nullable: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingDate: description: The ISO 6801 timestamp indicating when you activated the endpoint version on the staging network. format: date-time nullable: true type: string stagingStatus: description: 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 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. nullable: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED updateDate: description: The ISO 6801 timestamp indicating when you last modified the endpoint version. format: date-time type: string updatedBy: description: The identifier for the user who last modified the version. type: string versionNumber: description: The endpoint version number. type: integer page: default: 1 description: The number of the current page with results. minimum: 1 type: integer pageSize: default: 2147483647 description: The number of endpoint versions on each page with results. type: integer totalSize: description: The total number of endpoint versions available in the returned set. type: integer x-akamai: file-path: schemas/apiEndpointVersionListDto.yaml '403': description: You don't have permission to retrieve the API endpoint versions list. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml parameters: - description: The page number index, starting at the default value of `1`. example: '{{page}}' in: query name: page schema: default: 1 type: integer x-akamai: file-path: parameters/page-query.yaml - description: The number of endpoint versions on each page of results. example: '{{pageSize}}' in: query name: pageSize schema: default: 2147483647 example: 50 type: integer - description: __Enum__ The field to sort endpoint versions by. example: '{{sortBy}}' in: query name: sortBy schema: default: versionNumber example: updateDate type: string enum: - versionNumber - description - updateDate - updatedBy - basedOn - stagingStatus - productionStatus - description: __Enum__ The sort order, either `asc` for ascending or the default `desc` for descending. example: '{{sortOrder}}' in: query name: sortOrder schema: default: desc example: desc type: string enum: - asc - desc - description: __Enum__ The type of endpoint versions to return based on their visibility status. By default the API returns `ALL` endpoint version. You can instead decide to return `ONLY_VISIBLE` endpoint versions, or `ONLY_HIDDEN` endpoint versions. Run the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) and [Hide a version](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-hide) operations to control which endpoint versions are listed. example: '{{show}}' in: query name: show schema: default: ALL example: ONLY_VISIBLE type: string enum: - ALL - ONLY_VISIBLE - ONLY_HIDDEN - 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /endpoints/{apiEndPointId}/versions/{versionNumber}: parameters: - description: The unique identifier for the endpoint version. example: '{{versionNumber}}' in: path name: versionNumber required: true schema: example: 1 type: integer x-akamai: file-path: parameters/versionNumber-path.yaml - description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' in: path name: apiEndPointId required: true schema: example: 1 type: integer x-akamai: file-path: parameters/apiEndPointId-path.yaml get: description: Returns a summary for a specific endpoint version. The summary is for purely informational purposes, and you shouldn't use this operation's response in the corresponding [Edit a version](https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version) PUT request. For the PUT request, use the response object of [Get a version](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version-resource). operationId: get-endpoint-version summary: Get a version summary tags: - Versions externalDocs: description: See documentation for this operation in Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version responses: '200': description: API Endpoint version summary defined by API Endpoint ID and Version Number. content: application/json: example: apiVersionId: 574127 basePath: /bookstore description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. hidden: false productionStatus: ACTIVE source: null stagingStatus: ACTIVE apiCategoryIds: [] apiEndPointHosts: - bookstore.api.akamai.com apiResourceNames: - book - user - magazine availableActions: - ACTIVATE_ON_STAGING - VIEW_AAG_SETTINGS - ACTIVATE_ON_PRODUCTION - COMPARE_RAPID_SETTINGS - DELETE - HIDE_VERSION - CLONE_VERSION - EDIT_AAG_SETTINGS - EDIT_ENDPOINT_DEFINITION - RESOURCES - COMPARE_ENDPOINT schema: additionalProperties: false description: Contains summary information about a specific endpoint version. type: object properties: apiCategoryIds: description: The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints. type: array items: type: integer apiEndPointHosts: description: The hostname strings that may receive traffic for the endpoint. type: array items: type: string apiEndPointVersionId: description: The unique identifier for the endpoint version. type: integer apiResourceNames: description: The collection of resource names defined for the endpoint. The value is `null` for endpoints without any resources. type: array items: type: string availableActions: description: The collection of available actions that you can perform on the version depending on the version's activation status. type: array items: type: string enum: - CLONE_ENDPOINT - CLONE_VERSION - DELETE - RESOURCES - COMPARE_ENDPOINT - COMPARE_AAG_SETTINGS - COMPARE_RAPID_SETTINGS - COMPARE_RESOURCE_PURPOSES - VIEW_AAG_SETTINGS - EDIT_AAG_SETTINGS - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING - ACTIVATE_ON_PRODUCTION - DEACTIVATE_ON_STAGING - DEACTIVATE_ON_PRODUCTION - HIDE_VERSION - SHOW_VERSION basePath: description: The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Do not 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. type: string description: description: The description of the endpoint. type: string productionStatus: description: The version activation status in 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 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 in this network. type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingStatus: description: The version activation status in 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 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 in this network. type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED x-akamai: file-path: schemas/apiVersionSummaryDto.yaml '403': description: You don't have access to the endpoint. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '404': description: The API endpoint is not found. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string put: description: Updates details about an endpoint version that has never been activated on the staging or production network. You can configure the endpoint's security settings and other top-level metadata, or modify the endpoint's entire set of resources as an alternative to separate calls to [Edit a resource](https://techdocs.akamai.com/api-definitions/reference/put-version-resource). Note that the corresponding [Get a version](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version-resource) operation you need to run to GET the data uses a different URL. operationId: put-endpoint-version summary: Edit a version tags: - Versions externalDocs: description: See documentation for this operation in Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version requestBody: required: true content: application/json: example: akamaiSecurityRestrictions: null apiEndPointId: 492375 apiEndPointLocked: false apiEndPointName: Bookstore API apiEndPointScheme: http/https apiEndPointVersion: 574127 apiGatewayEnabled: true basePath: /bookstore caseSensitive: true clonedFromVersion: null consumeType: any contractId: K-0N7RAK7 createDate: 2019-06-12T13:06:52+0000 createdBy: alfulani description: An API for bookstore users allowing them to retrieve book items and modify existing items. endpointHidden: false graphQL: false groupId: 44681 isGraphQL: false lockVersion: 0 positiveConstrainsEnabled: true productionStatus: null protectedByApiKey: true responseConstraintsEnabled: false source: null stagingStatus: null updateDate: 2019-06-12T13:06:55+0000 updatedBy: bookstore_admin versionHidden: false versionNumber: 1 apiCategoryIds: [] apiEndPointHosts: - bookstore.api.akamai.com availableActions: - DELETE - CLONE_ENDPOINT - ACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING discoveredPiiIds: - 455976 productionVersion: lastError: null status: null timestamp: null versionNumber: null securityScheme: securitySchemeType: apikey securitySchemeDetail: apiKeyLocation: header apiKeyName: apikey stagingVersion: lastError: null status: null timestamp: null versionNumber: null apiResources: - apiResourceClonedFromId: null apiResourceId: 2926712 apiResourceLogicId: 118435 apiResourceName: books createDate: 2019-06-12T13:06:52+0000 createdBy: szhang description: A book item within the bookstore API. link: null lockVersion: 0 private: false resourcePath: /books/{bookId} updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin apiResourceMethods: - apiResourceMethod: GET apiResourceMethodId: 341591 apiResourceMethodLogicId: 184404 apiParameters: - apiParamLogicId: 578116 apiParameterId: 1212945 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string apiResourceMethParamId: 494448 array: false pathParamLocationId: 3 response: false apiChildParameters: [] - apiResourceMethod: POST apiResourceMethodId: 341592 apiResourceMethodLogicId: 184405 apiParameters: - apiParamLogicId: 578117 apiParameterId: 1212946 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterType: string apiResourceMethParamId: 494449 array: false pathParamLocationId: 3 response: false apiChildParameters: [] apiParameterRestriction: apiParameterType: json array: true numberRangeRestriction: null rangeRestriction: null xmlConversionRule: null arrayRestriction: maxItems: 200 minItems: 100 responseRestriction: maxBodySize: SIZE_6K statusCodes: - 200 - 201 schema: additionalProperties: false description: Contains information about an endpoint and its associated resources. type: object required: - apiEndPointName - apiEndPointHosts - groupId - contractId - lockVersion properties: akamaiSecurityRestrictions: additionalProperties: false description: 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. nullable: true type: object 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_BODY_PARAMS: description: Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_HEADER_PARAMS: description: Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_HEAD: description: Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_OPTIONS: description: Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PATCH: description: Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_PARAMS: description: Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_RESOURCES: description: Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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 KSD security policies. Either `1` for enabled security constraints, or `0` for disabled. type: integer enum: - 0 - 1 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. nullable: true type: integer enum: - 1 - 2 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`. type: integer enum: - 0 - 1 apiCategoryIds: description: The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints. nullable: true type: array items: type: integer apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint. minItems: 1 type: array items: type: string apiEndPointId: description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' nullable: true readOnly: true type: integer apiEndPointLocked: description: Whether the endpoint version is read-only. example: '{{apiEndPointLocked}}' nullable: true readOnly: true type: boolean apiEndPointName: description: The name of the endpoint, unique within the account. example: '{{apiEndPointName}}' type: string apiEndPointScheme: description: The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both. example: '{{apiEndPointScheme}}' nullable: true type: string enum: - http - https - http/https apiEndPointVersion: description: The unique identifier for the endpoint version. example: '{{apiEndPointVersion}}' 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`. example: '{{apiGatewayEnabled}}' nullable: true type: boolean apiResources: description: The list of resources assigned to the endpoint. nullable: true type: array items: additionalProperties: false description: Contains information about a resource assigned to an endpoint. type: object required: - apiResourceName - resourcePath 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: The list of HTTP methods the resource may respond to. type: array items: type: string apiResourceMethods: description: The list of HTTP methods the resource may respond to. type: array items: additionalProperties: false description: Contains information about an HTTP method to which a resource may respond. type: object required: - apiResourceMethod properties: apiParameters: description: The list of parameter objects assigned to the method. nullable: true type: array items: additionalProperties: false description: Contains information about a method's parameter. type: object required: - apiParameterName - apiParameterType - apiParameterRequired - apiParameterLocation properties: apiChildParameters: description: The collection of child JSON members or XML elements for JSON or XML body type parameters. type: array items: description: A further nested endpoint object. type: object x-akamai: file-path: schemas/apiParameterDto-nested.yaml apiParamLogicId: description: The unique identifier for the parameter across all endpoint versions. readOnly: true type: integer apiParameterContentType: description: The content type of the parameter. Only applicable for top level body parameters. type: string enum: - json - xml - urlencoded - json/xml - any - none apiParameterId: description: 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. type: string enum: - query - body - header - path - cookie 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: Contains information about restrictions and XML representation rules specified for the parameter. nullable: true type: object properties: arrayRestriction: additionalProperties: false description: Contains information about array restrictions for array type parameters. Define this object only if you enabled the corresponding `array` member. nullable: true type: object 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. type: string enum: - csv - ssv - tsv - pipes - multi maxItems: description: The maximum allowed number of array items. type: integer minItems: description: The minimum allowed number of array items. type: integer uniqueItems: description: Whether the array contains only unique items. type: boolean lengthRestriction: additionalProperties: false description: Contains information about length restrictions for string type parameters. nullable: true type: object 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 numberRangeRestriction: additionalProperties: false description: Contains information about range restrictions for number type parameters. nullable: true type: object properties: numberRangeMax: description: The maximum range restriction. nullable: true type: number numberRangeMin: description: The minimum range restriction. nullable: true type: number rangeRestriction: additionalProperties: false description: Contains information about range restrictions for integer type parameters. nullable: true type: object properties: rangeMax: description: The maximum range restriction. nullable: true type: integer rangeMin: description: The minimum range restriction. nullable: true type: integer responseRestriction: additionalProperties: false type: object 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. type: string enum: - SIZE_6K - SIZE_8K - SIZE_12K - NO_LIMIT 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. nullable: true type: array items: type: integer xmlConversionRule: additionalProperties: false description: Contains information about an XML representation of a JSON-encoded parameter. nullable: true type: object 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 x-akamai: file-path: schemas/xmlRestrictionDto.yaml apiParameterType: description: The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects. type: string enum: - string - integer - number - boolean - json/xml apiResourceMethParamId: description: 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 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: number response: description: Whether the parameter is within a response type. type: boolean x-akamai: file-path: schemas/apiParameterDto.yaml apiResourceMethod: description: The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`. type: string enum: - GET - PUT - POST - DELETE - HEAD - PATCH - OPTIONS apiResourceMethodId: description: The unique identifier for the resource's allowed method. nullable: true readOnly: true type: integer apiResourceMethodLogicId: description: The unique identifier for the resource's method across all endpoint versions. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiMethodParametersDto.yaml apiResourceName: description: The name of the resource. type: string createDate: description: The ISO 6801 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. 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: number 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 6801 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 x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml apiSource: description: Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`. example: '{{apiSource}}' nullable: true type: string enum: - USER - API_DISCOVERY apiVersionInfo: additionalProperties: false description: 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. nullable: true type: object required: - location properties: location: description: The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter. type: string enum: - HEADER - BASE_PATH - QUERY 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 x-akamai: file-path: schemas/apiVersionInfo.yaml availableActions: description: The collection of available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2). minItems: 0 nullable: true readOnly: true type: array items: type: string 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 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. example: '{{basePath}}' minLength: 0 nullable: true type: string caseSensitive: description: Whether the URLs and parameters within the endpoint are case sensitive. example: '{{caseSensitive}}' nullable: true type: boolean clonedFromVersion: description: For cloned endpoints, the unique identifier for the source endpoint version. example: '{{clonedFromVersion}}' 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. example: '{{consumeType}}' nullable: true type: string enum: - none - json - xml - json/xml - any - urlencoded - json/urlencoded - xml/urlencoded - json/xml/urlencoded contractId: description: The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API. example: '{{contractId}}' nullable: true readOnly: true type: string createDate: description: The ISO 6801 timestamp indicating when you created the endpoint. example: '{{createDate}}' format: date-time nullable: true readOnly: true type: string createdBy: description: The identifier for the user who created the endpoint. example: '{{createdBy}}' 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. example: '{{description}}' nullable: true type: string discoveredPiiIds: description: The collection of personally identifiable information (PII) in your API parameters discovered by the network. nullable: true type: array items: type: integer endpointHidden: description: 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. example: '{{endpointHidden}}' nullable: true readOnly: true type: boolean groupId: description: The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API. example: '{{groupId}}' nullable: true readOnly: true type: integer isGraphQL: description: Whether the endpoint uses GraphQL to deliver structured content to clients. example: '{{isGraphQL}}' type: boolean lockVersion: description: 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. example: '{{lockVersion}}' 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`. example: '{{matchPathSegmentParam}}' nullable: true type: boolean positiveConstrainsEnabled: description: Specifies whether the KSD firewall policies are enabled for the endpoint. example: '{{positiveConstrainsEnabled}}' nullable: true type: boolean productionStatus: description: 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. example: '{{productionStatus}}' nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED productionVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the production network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml protectedByApiKey: description: Whether you enabled API key protection for the endpoint version by making the version private. example: '{{protectedByApiKey}}' readOnly: true type: boolean responseConstraintsEnabled: description: 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. example: '{{responseConstraintsEnabled}}' nullable: true readOnly: true type: boolean securityScheme: additionalProperties: false description: Contains information about the key with which users may access the endpoint. nullable: true type: object properties: securitySchemeDetail: additionalProperties: false description: Contains information about the location of the API key. type: object properties: apiKeyLocation: description: The location of the API key in incoming requests, either `cookie`, `header`, or `query` parameter. type: string enum: - cookie - header - query apiKeyName: description: The name of the header, query parameter, or cookie where you located the API key. type: string securitySchemeType: description: The type of security scheme implemented for the endpoint. The only valid value is `apikey`. type: string enum: - apikey source: additionalProperties: false description: Contains information about the import file used to create the endpoint. nullable: true readOnly: true type: object properties: apiVersion: description: The major version of the API defined in the import file. nullable: true readOnly: true type: string specificationVersion: description: The version of the import file's specification. example: 3.0.0 nullable: true readOnly: true type: string type: description: The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`. nullable: true readOnly: true type: string enum: - SWAGGER - RAML x-akamai: file-path: schemas/apiEndpointSourceDto.yaml stagingStatus: description: 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. example: '{{stagingStatus}}' nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the staging network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml updateDate: description: The ISO 6801 timestamp indicating when you last modified the endpoint. example: '{{updateDate}}' format: date-time nullable: true readOnly: true type: string updatedBy: description: The identifier for the user who last modified the endpoint. example: '{{updatedBy}}' nullable: true readOnly: true type: string versionHidden: description: 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. example: '{{versionHidden}}' nullable: true readOnly: true type: boolean versionNumber: description: The endpoint version number. example: '{{versionNumber}}' nullable: true type: integer x-akamai: file-path: schemas/apiEndpointWithResourceDto-recurse.yaml responses: '200': description: Modify details of an endpoint version. content: application/json: example: akamaiSecurityRestrictions: null apiEndPointId: 492375 apiEndPointLocked: false apiEndPointName: Bookstore API apiEndPointScheme: http/https apiEndPointVersion: 574127 apiGatewayEnabled: true basePath: /bookstore caseSensitive: true clonedFromVersion: null consumeType: any contractId: K-0N7RAK71 createDate: 2019-06-12T13:06:52+0000 createdBy: adevi description: An API for bookstore users allowing them to retrieve book items and modify existing items. endpointHidden: false graphQL: false groupId: 44681 isGraphQL: false lockVersion: 0 positiveConstrainsEnabled: true productionStatus: null protectedByApiKey: true responseConstraintsEnabled: false source: null stagingStatus: null updateDate: 2019-06-12T13:06:55+0000 updatedBy: bookstore_admin versionHidden: false versionNumber: 1 apiCategoryIds: [] apiEndPointHosts: - bookstore.api.akamai.com availableActions: - DELETE - CLONE_ENDPOINT - ACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING discoveredPiiIds: - 455976 productionVersion: lastError: null status: null timestamp: null versionNumber: null securityScheme: securitySchemeType: apikey securitySchemeDetail: apiKeyLocation: header apiKeyName: apikey stagingVersion: lastError: null status: null timestamp: null versionNumber: null apiResources: - apiResourceClonedFromId: null apiResourceId: 2926712 apiResourceLogicId: 118435 apiResourceName: books createDate: 2019-06-12T13:06:52+0000 createdBy: hgildong description: A book item within the bookstore API. link: null lockVersion: 0 private: false resourcePath: /books/{bookId} updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin apiResourceMethods: - apiResourceMethod: GET apiResourceMethodId: 341591 apiResourceMethodLogicId: 184404 apiParameters: - apiParamLogicId: 578116 apiParameterId: 1212945 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string apiResourceMethParamId: 494448 array: false pathParamLocationId: 3 response: false apiChildParameters: [] - apiResourceMethod: POST apiResourceMethodId: 341592 apiResourceMethodLogicId: 184405 apiParameters: - apiParamLogicId: 578117 apiParameterId: 1212946 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterType: string apiResourceMethParamId: 494449 array: false pathParamLocationId: 3 response: false apiChildParameters: [] apiParameterRestriction: apiParameterType: json array: true numberRangeRestriction: null rangeRestriction: null xmlConversionRule: null arrayRestriction: maxItems: 200 minItems: 100 responseRestriction: maxBodySize: SIZE_6K statusCodes: - 200 - 201 schema: additionalProperties: false description: Contains information about an endpoint and its associated resources. type: object required: - apiEndPointName - apiEndPointHosts - groupId - contractId - lockVersion properties: akamaiSecurityRestrictions: additionalProperties: false description: 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. nullable: true type: object 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_BODY_PARAMS: description: Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_HEADER_PARAMS: description: Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_HEAD: description: Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_OPTIONS: description: Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PATCH: description: Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_PARAMS: description: Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_RESOURCES: description: Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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 KSD security policies. Either `1` for enabled security constraints, or `0` for disabled. type: integer enum: - 0 - 1 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. nullable: true type: integer enum: - 1 - 2 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`. type: integer enum: - 0 - 1 apiCategoryIds: description: The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints. nullable: true type: array items: type: integer apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint. minItems: 1 type: array items: type: string apiEndPointId: description: The unique identifier for the endpoint. nullable: true readOnly: true type: integer apiEndPointLocked: description: 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. nullable: true type: string enum: - http - https - http/https apiEndPointVersion: description: 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 apiResources: description: The list of resources assigned to the endpoint. nullable: true type: array items: additionalProperties: false description: Contains information about a resource assigned to an endpoint. type: object required: - apiResourceName - resourcePath 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: The list of HTTP methods the resource may respond to. type: array items: type: string apiResourceMethods: description: The list of HTTP methods the resource may respond to. type: array items: additionalProperties: false description: Contains information about an HTTP method to which a resource may respond. type: object required: - apiResourceMethod properties: apiParameters: description: The list of parameter objects assigned to the method. nullable: true type: array items: additionalProperties: false description: Contains information about a method's parameter. type: object required: - apiParameterName - apiParameterType - apiParameterRequired - apiParameterLocation properties: apiChildParameters: description: The collection of child JSON members or XML elements for JSON or XML body type parameters. type: array items: description: A further nested endpoint object. type: object x-akamai: file-path: schemas/apiParameterDto-nested.yaml apiParamLogicId: description: The unique identifier for the parameter across all endpoint versions. readOnly: true type: integer apiParameterContentType: description: The content type of the parameter. Only applicable for top level body parameters. type: string enum: - json - xml - urlencoded - json/xml - any - none apiParameterId: description: 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. type: string enum: - query - body - header - path - cookie 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: Contains information about restrictions and XML representation rules specified for the parameter. nullable: true type: object properties: arrayRestriction: additionalProperties: false description: Contains information about array restrictions for array type parameters. Define this object only if you enabled the corresponding `array` member. nullable: true type: object 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. type: string enum: - csv - ssv - tsv - pipes - multi maxItems: description: The maximum allowed number of array items. type: integer minItems: description: The minimum allowed number of array items. type: integer uniqueItems: description: Whether the array contains only unique items. type: boolean lengthRestriction: additionalProperties: false description: Contains information about length restrictions for string type parameters. nullable: true type: object 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 numberRangeRestriction: additionalProperties: false description: Contains information about range restrictions for number type parameters. nullable: true type: object properties: numberRangeMax: description: The maximum range restriction. nullable: true type: number numberRangeMin: description: The minimum range restriction. nullable: true type: number rangeRestriction: additionalProperties: false description: Contains information about range restrictions for integer type parameters. nullable: true type: object properties: rangeMax: description: The maximum range restriction. nullable: true type: integer rangeMin: description: The minimum range restriction. nullable: true type: integer responseRestriction: additionalProperties: false type: object 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. type: string enum: - SIZE_6K - SIZE_8K - SIZE_12K - NO_LIMIT 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. nullable: true type: array items: type: integer xmlConversionRule: additionalProperties: false description: Contains information about an XML representation of a JSON-encoded parameter. nullable: true type: object 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 x-akamai: file-path: schemas/xmlRestrictionDto.yaml apiParameterType: description: The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects. type: string enum: - string - integer - number - boolean - json/xml apiResourceMethParamId: description: 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 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: number response: description: Whether the parameter is within a response type. type: boolean x-akamai: file-path: schemas/apiParameterDto.yaml apiResourceMethod: description: The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`. type: string enum: - GET - PUT - POST - DELETE - HEAD - PATCH - OPTIONS apiResourceMethodId: description: The unique identifier for the resource's allowed method. nullable: true readOnly: true type: integer apiResourceMethodLogicId: description: The unique identifier for the resource's method across all endpoint versions. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiMethodParametersDto.yaml apiResourceName: description: The name of the resource. type: string createDate: description: The ISO 6801 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. 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: number 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 6801 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 x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml apiSource: description: Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`. nullable: true type: string enum: - USER - API_DISCOVERY apiVersionInfo: additionalProperties: false description: 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. nullable: true type: object required: - location properties: location: description: The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter. type: string enum: - HEADER - BASE_PATH - QUERY 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 x-akamai: file-path: schemas/apiVersionInfo.yaml availableActions: description: The collection of available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2). minItems: 0 nullable: true readOnly: true type: array items: type: string 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 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: 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. nullable: true type: string enum: - none - json - xml - json/xml - any - urlencoded - json/urlencoded - xml/urlencoded - json/xml/urlencoded contractId: description: 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: The ISO 6801 timestamp indicating when you created the endpoint. format: date-time nullable: true readOnly: true type: string createdBy: description: 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: The collection of personally identifiable information (PII) in your API parameters discovered by the network. nullable: true type: array items: type: integer endpointHidden: description: 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: 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: 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 KSD firewall policies are enabled for the endpoint. nullable: true type: boolean productionStatus: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED productionVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the production network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml protectedByApiKey: description: Whether you enabled API key protection for the endpoint version by making the version private. readOnly: true type: boolean responseConstraintsEnabled: description: 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: Contains information about the key with which users may access the endpoint. nullable: true type: object properties: securitySchemeDetail: additionalProperties: false description: Contains information about the location of the API key. type: object properties: apiKeyLocation: description: The location of the API key in incoming requests, either `cookie`, `header`, or `query` parameter. type: string enum: - cookie - header - query apiKeyName: description: The name of the header, query parameter, or cookie where you located the API key. type: string securitySchemeType: description: The type of security scheme implemented for the endpoint. The only valid value is `apikey`. type: string enum: - apikey source: additionalProperties: false description: Contains information about the import file used to create the endpoint. nullable: true readOnly: true type: object properties: apiVersion: description: The major version of the API defined in the import file. nullable: true readOnly: true type: string specificationVersion: description: The version of the import file's specification. example: 3.0.0 nullable: true readOnly: true type: string type: description: The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`. nullable: true readOnly: true type: string enum: - SWAGGER - RAML x-akamai: file-path: schemas/apiEndpointSourceDto.yaml stagingStatus: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the staging network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml updateDate: description: The ISO 6801 timestamp indicating when you last modified the endpoint. format: date-time nullable: true readOnly: true type: string updatedBy: description: The identifier for the user who last modified the endpoint. nullable: true readOnly: true type: string versionHidden: description: 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 x-akamai: file-path: schemas/apiEndpointWithResourceDto-recurse.yaml '400': description: Some of user input is invalid. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '403': description: You don't have access to the endpoint. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '404': description: The API endpoint is not found. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '409': description: '[Conflict](https://techdocs.akamai.com/api-definitions/reference/409)' content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string delete: description: Removes an endpoint version from API Gateway if the version has never been activated on the staging or production network. This is a soft delete operation that preserves the version's information, such as its number, in the database. You can't remove the permanent number assigned to each endpoint version, even if you remove that version. A removed endpoint version no longer appears in the [List versions](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-versions) operation's response object. operationId: delete-endpoint-version summary: Delete a version tags: - Versions externalDocs: description: See documentation for this operation in Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference/delete-endpoint-version responses: '204': description: Resource successfully deleted. content: '*/*': {} '403': description: You don't have access to the endpoint. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '404': description: The API endpoint is not found. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /endpoints/{apiEndPointId}/versions/{versionNumber}/activate: parameters: - description: The unique identifier for the endpoint version. example: '{{versionNumber}}' in: path name: versionNumber required: true schema: example: 1 type: integer x-akamai: file-path: parameters/versionNumber-path.yaml - description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' in: path name: apiEndPointId required: true schema: example: 1 type: integer x-akamai: file-path: parameters/apiEndPointId-path.yaml post: description: Activates an endpoint version on the staging or production network. If another version of the endpoint is already active on the specified network, that version automatically deactivates and the newly activated version takes its place. If an active version of another endpoint shares any hostnames with the version you activate, the API automatically deactivates the version with conflicting hostnames, creates a new version of the impacted endpoint, migrates the non-conflicting hostnames and other API details to the new version, and activates the new version. operationId: post-endpoint-version-activate summary: Activate a version tags: - Versions 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-activate requestBody: required: true content: application/json: example: notes: Activating the first version of the Bookstore API on both staging and production networks. networks: - STAGING - PRODUCTION notificationRecipients: - bookstore_shared@akamai.com schema: additionalProperties: false description: Contains information about an endpoint version activation. type: object required: - networks properties: networks: description: The network environments where you activate the endpoint version, either `STAGING` or `PRODUCTION`. type: array items: type: string enum: - STAGING - PRODUCTION notes: description: The notes describing the version that you activate. example: '{{notes}}' type: string notificationRecipients: description: The email addresses where the system sends the activation notification. type: array items: type: string x-akamai: file-path: schemas/activationDto.yaml responses: '200': description: Returns the activated entity. content: application/json: example: notes: Activating the first version of the Bookstore API on both staging and production networks. networks: - STAGING - PRODUCTION notificationRecipients: - bookstore_shared@akamai.com schema: additionalProperties: false description: Contains information about an endpoint version activation. type: object required: - networks properties: networks: description: The network environments where you activate the endpoint version, either `STAGING` or `PRODUCTION`. type: array items: type: string enum: - STAGING - PRODUCTION notes: description: The notes describing the version that you activate. type: string notificationRecipients: description: The email addresses where the system sends the activation notification. type: array items: type: string x-akamai: file-path: schemas/activationDto.yaml '400': description: Some of user input is invalid. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /endpoints/{apiEndPointId}/versions/{versionNumber}/cloneVersion: parameters: - description: The unique identifier for the endpoint version. example: '{{versionNumber}}' in: path name: versionNumber required: true schema: example: 1 type: integer x-akamai: file-path: parameters/versionNumber-path.yaml - description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' in: path name: apiEndPointId required: true schema: example: 1 type: integer x-akamai: file-path: parameters/apiEndPointId-path.yaml 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. operationId: post-endpoint-version-clone summary: Clone a version tags: - Versions 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 responses: '200': description: Updated API Endpoint. content: application/json: example: akamaiSecurityRestrictions: null apiEndPointId: 492375 apiEndPointLocked: false apiEndPointName: Bookstore API Premium apiEndPointScheme: http/https apiEndPointVersion: 574127 basePath: /bookstore-premium caseSensitive: true clonedFromVersion: 1 consumeType: any contractId: C-0N7RAC7 createDate: 2019-06-12T13:06:52+0000 createdBy: jkowalski description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. endpointHidden: false graphQL: false groupId: 44681 isGraphQL: false lockVersion: 2 positiveConstrainsEnabled: null productionStatus: null protectedByApiKey: true source: null stagingStatus: null updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin versionHidden: false versionNumber: 2 apiCategoryIds: - 2 - 7 apiEndPointHosts: - bookstore.api.akamai.com availableActions: - DELETE - CLONE_ENDPOINT - ACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING productionVersion: lastError: null status: null timestamp: null versionNumber: null securityScheme: securitySchemeType: apikey securitySchemeDetail: apiKeyLocation: header apiKeyName: apikey stagingVersion: lastError: null status: null timestamp: null versionNumber: null apiResources: - apiResourceClonedFromId: null apiResourceId: 2926712 apiResourceLogicId: 118435 apiResourceName: books createDate: 2019-06-12T13:06:52+0000 createdBy: mrossi description: A book item within the bookstore API. link: null lockVersion: 2 private: false resourcePath: /books/{bookId} updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin apiResourceMethods: - apiResourceMethod: GET apiResourceMethodId: 341591 apiResourceMethodLogicId: 184404 apiParameters: - apiParamLogicId: 578116 apiParameterId: 1212945 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string apiResourceMethParamId: 494448 array: false pathParamLocationId: null apiChildParameters: [] - apiResourceMethod: POST apiResourceMethodId: 341592 apiResourceMethodLogicId: 184405 apiParameters: - apiParamLogicId: 578117 apiParameterContentType: json apiParameterId: 1212946 apiParameterLocation: body apiParameterName: books apiParameterNotes: null apiParameterRequired: true apiParameterType: string apiResourceMethParamId: 494449 array: true pathParamLocationId: null apiChildParameters: [] apiParameterRestriction: arrayRestriction: null numberRangeRestriction: null rangeRestriction: null xmlConversionRule: null lengthRestriction: lengthMax: 15 lengthMin: 3 schema: additionalProperties: false description: Contains information about an endpoint and its associated resources. type: object required: - apiEndPointName - apiEndPointHosts - groupId - contractId - lockVersion properties: akamaiSecurityRestrictions: additionalProperties: false description: 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. nullable: true type: object 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_BODY_PARAMS: description: Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_HEADER_PARAMS: description: Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_HEAD: description: Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_OPTIONS: description: Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PATCH: description: Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_PARAMS: description: Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_RESOURCES: description: Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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 KSD security policies. Either `1` for enabled security constraints, or `0` for disabled. type: integer enum: - 0 - 1 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. nullable: true type: integer enum: - 1 - 2 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`. type: integer enum: - 0 - 1 apiCategoryIds: description: The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints. nullable: true type: array items: type: integer apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint. minItems: 1 type: array items: type: string apiEndPointId: description: The unique identifier for the endpoint. nullable: true readOnly: true type: integer apiEndPointLocked: description: 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. nullable: true type: string enum: - http - https - http/https apiEndPointVersion: description: 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 apiResources: description: The list of resources assigned to the endpoint. nullable: true type: array items: additionalProperties: false description: Contains information about a resource assigned to an endpoint. type: object required: - apiResourceName - resourcePath 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: The list of HTTP methods the resource may respond to. type: array items: type: string apiResourceMethods: description: The list of HTTP methods the resource may respond to. type: array items: additionalProperties: false description: Contains information about an HTTP method to which a resource may respond. type: object required: - apiResourceMethod properties: apiParameters: description: The list of parameter objects assigned to the method. nullable: true type: array items: additionalProperties: false description: Contains information about a method's parameter. type: object required: - apiParameterName - apiParameterType - apiParameterRequired - apiParameterLocation properties: apiChildParameters: description: The collection of child JSON members or XML elements for JSON or XML body type parameters. type: array items: description: A further nested endpoint object. type: object x-akamai: file-path: schemas/apiParameterDto-nested.yaml apiParamLogicId: description: The unique identifier for the parameter across all endpoint versions. readOnly: true type: integer apiParameterContentType: description: The content type of the parameter. Only applicable for top level body parameters. type: string enum: - json - xml - urlencoded - json/xml - any - none apiParameterId: description: 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. type: string enum: - query - body - header - path - cookie 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: Contains information about restrictions and XML representation rules specified for the parameter. nullable: true type: object properties: arrayRestriction: additionalProperties: false description: Contains information about array restrictions for array type parameters. Define this object only if you enabled the corresponding `array` member. nullable: true type: object 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. type: string enum: - csv - ssv - tsv - pipes - multi maxItems: description: The maximum allowed number of array items. type: integer minItems: description: The minimum allowed number of array items. type: integer uniqueItems: description: Whether the array contains only unique items. type: boolean lengthRestriction: additionalProperties: false description: Contains information about length restrictions for string type parameters. nullable: true type: object 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 numberRangeRestriction: additionalProperties: false description: Contains information about range restrictions for number type parameters. nullable: true type: object properties: numberRangeMax: description: The maximum range restriction. nullable: true type: number numberRangeMin: description: The minimum range restriction. nullable: true type: number rangeRestriction: additionalProperties: false description: Contains information about range restrictions for integer type parameters. nullable: true type: object properties: rangeMax: description: The maximum range restriction. nullable: true type: integer rangeMin: description: The minimum range restriction. nullable: true type: integer responseRestriction: additionalProperties: false type: object 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. type: string enum: - SIZE_6K - SIZE_8K - SIZE_12K - NO_LIMIT 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. nullable: true type: array items: type: integer xmlConversionRule: additionalProperties: false description: Contains information about an XML representation of a JSON-encoded parameter. nullable: true type: object 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 x-akamai: file-path: schemas/xmlRestrictionDto.yaml apiParameterType: description: The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects. type: string enum: - string - integer - number - boolean - json/xml apiResourceMethParamId: description: 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 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: number response: description: Whether the parameter is within a response type. type: boolean x-akamai: file-path: schemas/apiParameterDto.yaml apiResourceMethod: description: The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`. type: string enum: - GET - PUT - POST - DELETE - HEAD - PATCH - OPTIONS apiResourceMethodId: description: The unique identifier for the resource's allowed method. nullable: true readOnly: true type: integer apiResourceMethodLogicId: description: The unique identifier for the resource's method across all endpoint versions. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiMethodParametersDto.yaml apiResourceName: description: The name of the resource. type: string createDate: description: The ISO 6801 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. 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: number 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 6801 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 x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml apiSource: description: Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`. nullable: true type: string enum: - USER - API_DISCOVERY apiVersionInfo: additionalProperties: false description: 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. nullable: true type: object required: - location properties: location: description: The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter. type: string enum: - HEADER - BASE_PATH - QUERY 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 x-akamai: file-path: schemas/apiVersionInfo.yaml availableActions: description: The collection of available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2). minItems: 0 nullable: true readOnly: true type: array items: type: string 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 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: 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. nullable: true type: string enum: - none - json - xml - json/xml - any - urlencoded - json/urlencoded - xml/urlencoded - json/xml/urlencoded contractId: description: 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: The ISO 6801 timestamp indicating when you created the endpoint. format: date-time nullable: true readOnly: true type: string createdBy: description: 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: The collection of personally identifiable information (PII) in your API parameters discovered by the network. nullable: true type: array items: type: integer endpointHidden: description: 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: 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: 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 KSD firewall policies are enabled for the endpoint. nullable: true type: boolean productionStatus: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED productionVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the production network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml protectedByApiKey: description: Whether you enabled API key protection for the endpoint version by making the version private. readOnly: true type: boolean responseConstraintsEnabled: description: 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: Contains information about the key with which users may access the endpoint. nullable: true type: object properties: securitySchemeDetail: additionalProperties: false description: Contains information about the location of the API key. type: object properties: apiKeyLocation: description: The location of the API key in incoming requests, either `cookie`, `header`, or `query` parameter. type: string enum: - cookie - header - query apiKeyName: description: The name of the header, query parameter, or cookie where you located the API key. type: string securitySchemeType: description: The type of security scheme implemented for the endpoint. The only valid value is `apikey`. type: string enum: - apikey source: additionalProperties: false description: Contains information about the import file used to create the endpoint. nullable: true readOnly: true type: object properties: apiVersion: description: The major version of the API defined in the import file. nullable: true readOnly: true type: string specificationVersion: description: The version of the import file's specification. example: 3.0.0 nullable: true readOnly: true type: string type: description: The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`. nullable: true readOnly: true type: string enum: - SWAGGER - RAML x-akamai: file-path: schemas/apiEndpointSourceDto.yaml stagingStatus: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the staging network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml updateDate: description: The ISO 6801 timestamp indicating when you last modified the endpoint. format: date-time nullable: true readOnly: true type: string updatedBy: description: The identifier for the user who last modified the endpoint. nullable: true readOnly: true type: string versionHidden: description: 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 x-akamai: file-path: schemas/apiEndpointWithResourceDto-recurse.yaml '403': description: You don't have access to the endpoint. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '404': description: The API endpoint is not found. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '409': description: '[Conflict](https://techdocs.akamai.com/api-definitions/reference/409).' content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /endpoints/{apiEndPointId}/versions/{versionNumber}/deactivate: parameters: - description: The unique identifier for the endpoint version. example: '{{versionNumber}}' in: path name: versionNumber required: true schema: example: 1 type: integer x-akamai: file-path: parameters/versionNumber-path.yaml - description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' in: path name: apiEndPointId required: true schema: example: 1 type: integer x-akamai: file-path: parameters/apiEndPointId-path.yaml post: description: Deactivates an endpoint version on the staging or production network. A deactivated endpoint version no longer serves traffic through the Akamai network. operationId: post-endpoint-version-deactivate summary: Deactivate a version tags: - Versions 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-deactivate requestBody: required: true content: application/json: example: notes: Activating the first version of the Bookstore API on both staging and production networks. networks: - STAGING - PRODUCTION notificationRecipients: - bookstore_shared@akamai.com schema: additionalProperties: false description: Contains information about an endpoint version activation. type: object required: - networks properties: networks: description: The network environments where you activate the endpoint version, either `STAGING` or `PRODUCTION`. type: array items: type: string enum: - STAGING - PRODUCTION notes: description: The notes describing the version that you activate. example: '{{notes}}' type: string notificationRecipients: description: The email addresses where the system sends the activation notification. type: array items: type: string x-akamai: file-path: schemas/activationDto.yaml responses: '200': description: Returns deactivated entity. content: application/json: example: notes: Activating the first version of the Bookstore API on both staging and production networks. networks: - STAGING - PRODUCTION notificationRecipients: - bookstore_shared@akamai.com schema: additionalProperties: false description: Contains information about an endpoint version activation. type: object required: - networks properties: networks: description: The network environments where you activate the endpoint version, either `STAGING` or `PRODUCTION`. type: array items: type: string enum: - STAGING - PRODUCTION notes: description: The notes describing the version that you activate. type: string notificationRecipients: description: The email addresses where the system sends the activation notification. type: array items: type: string x-akamai: file-path: schemas/activationDto.yaml '400': description: Some of user input is invalid. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /endpoints/{apiEndPointId}/versions/{versionNumber}/file: parameters: - description: The unique identifier for the endpoint version. example: '{{versionNumber}}' in: path name: versionNumber required: true schema: example: 1 type: integer x-akamai: file-path: parameters/versionNumber-path.yaml - description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' in: path name: apiEndPointId required: true schema: example: 1 type: integer x-akamai: file-path: parameters/apiEndPointId-path.yaml post: description: Imports an API definition file with details about an endpoint. Unlike [Register an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/post-endpoints-file), this operation doesn't create a new endpoint, but updates details of an existing endpoint. You can run this operation in two ways. To POST JSON data, see [Make a JSON request to edit an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/endpoint-edit-json). To make a form request using these parameters, see [Make a form request to edit an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/endpoint-edit-form). Once you submit the POST request, to finish modifying the endpoint version, you need to take the response data and submit it as a request to the [Edit a version](https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version) operation. operationId: post-endpoint-version-file summary: Edit an endpoint from an API definition file tags: - Versions 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-file requestBody: required: true content: application/json: example: contractId: C-0N7RAC71 groupId: 44681 importFileContent: ewogICJzd2FnZ2VyIjogIjIuMCIsCiAgImluZm8iOiB7CiAgICAidmVyc2lvbiI6ICIxLjAuMCIsCiAgICAidGl0bGUiOiAiQm9va3N0b3JlIEFQSSIsCiAgICAiZGVzY3JpcHRpb24iOiAiQW4gQVBJIGZvciBib29rc3RvcmUgdXNlcnMgYWxsb3dpbmcgdGhlbSB0byByZXRyaWV2ZSBib29rIGl0ZW1zLCBhZGQgbmV3IGl0ZW1zIChhZG1pbiB1c2VycyksIGFuZCBtb2RpZnkgZXhpc3RpbmcgaXRlbXMuIgogIH0sCiAgImhvc3QiOiAiYm9va3N0b3JlLmFwaS5ha2FtYWkuY29tIiwKICAic2NoZW1lcyI6IFsKICAgICJodHRwIiwKICAgICJodHRwcyIKICBdLAogICJzZWN1cml0eURlZmluaXRpb25zIjogewogICAgImFwaV9rZXkiOiB7CiAgICAgICJ0eXBlIjogImFwaUtleSIsCiAgICAgICJuYW1lIjogImFwaUtleSIsCiAgICAgICJpbiI6ICJoZWFkZXIiCiAgICB9CiAgfSwKICAiYmFzZVBhdGgiOiAiL2Jvb2tzdG9yZSIsCiAgInBhdGhzIjogewogICAgIi9ib29rcyI6IHsKICAgICAgImdldCI6IHsKICAgICAgICAiZGVzY3JpcHRpb24iOiAiTGlzdHMgYWxsIGJvb2sgaXRlbXMuIiwKICAgICAgICAib3BlcmF0aW9uSWQiOiAiZ2V0Qm9va3MiLAogICAgICAgICJwcm9kdWNlcyI6IFsKICAgICAgICAgICJhcHBsaWNhdGlvbi9qc29uIgogICAgICAgIF0sCiAgICAgICAgInJlc3BvbnNlcyI6IHsKICAgICAgICAgICIyMDAiOiB7CiAgICAgICAgICAgICJkZXNjcmlwdGlvbiI6ICJCb29rIHJlc3BvbnNlLiIsCiAgICAgICAgICAgICJzY2hlbWEiOiB7CiAgICAgICAgICAgICAgInR5cGUiOiAiYXJyYXkiLAogICAgICAgICAgICAgICJpdGVtcyI6IHsKICAgICAgICAgICAgICAgICIkcmVmIjogIiMvZGVmaW5pdGlvbnMvYm9vayIKICAgICAgICAgICAgICB9CiAgICAgICAgICAgIH0KICAgICAgICAgIH0KICAgICAgICB9CiAgICAgIH0sCiAgICAgICJwb3N0IjogewogICAgICAgICJkZXNjcmlwdGlvbiI6ICJDcmVhdGVzIGEgYm9vayBpdGVtIGluIHRoZSBib29rc3RvcmUuIiwKICAgICAgICAib3BlcmF0aW9uSWQiOiAicG9zdEJvb2siLAogICAgICAgICJwcm9kdWNlcyI6IFsKICAgICAgICAgICJhcHBsaWNhdGlvbi9qc29uIgogICAgICAgIF0sCiAgICAgICAgInBhcmFtZXRlcnMiOiBbewogICAgICAgICAgIm5hbWUiOiAiYm9vayIsCiAgICAgICAgICAiaW4iOiAiYm9keSIsCiAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiQSBib29rIHRvIGFkZCB0byB0aGUgYm9va3N0b3JlLiIsCiAgICAgICAgICAicmVxdWlyZWQiOiB0cnVlLAogICAgICAgICAgInNjaGVtYSI6IHsKICAgICAgICAgICAgIiRyZWYiOiAiIy9kZWZpbml0aW9ucy9uZXdCb29rIgogICAgICAgICAgfQogICAgICAgIH1dLAogICAgICAgICJyZXNwb25zZXMiOiB7CiAgICAgICAgICAiMjAwIjogewogICAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiQm9vayByZXNwb25zZS4iLAogICAgICAgICAgICAic2NoZW1hIjogewogICAgICAgICAgICAgICJ0eXBlIjogInN0cmluZyIsCiAgICAgICAgICAgICAgIiRyZWYiOiAiIy9kZWZpbml0aW9ucy9ib29rIgogICAgICAgICAgICB9CiAgICAgICAgICB9CiAgICAgICAgfQogICAgICB9CiAgICB9LAogICAgIi9ib29rcy97aWR9IjogewogICAgICAiZ2V0IjogewogICAgICAgICJkZXNjcmlwdGlvbiI6ICJSZXR1cm5zIGEgYm9vayBpdGVtLiIsCiAgICAgICAgIm9wZXJhdGlvbklkIjogImdldEJvb2siLAogICAgICAgICJwcm9kdWNlcyI6IFsKICAgICAgICAgICJhcHBsaWNhdGlvbi9qc29uIgogICAgICAgIF0sCiAgICAgICAgInBhcmFtZXRlcnMiOiBbewogICAgICAgICAgIm5hbWUiOiAiaWQiLAogICAgICAgICAgImluIjogInBhdGgiLAogICAgICAgICAgImRlc2NyaXB0aW9uIjogIkEgc3BlY2lmaWMgSUQgb2YgYSBib29rIGl0ZW0gdG8gcmV0dXJuLiIsCiAgICAgICAgICAicmVxdWlyZWQiOiB0cnVlLAogICAgICAgICAgInR5cGUiOiAiaW50ZWdlciIKICAgICAgICB9XSwKICAgICAgICAicmVzcG9uc2VzIjogewogICAgICAgICAgIjIwMCI6IHsKICAgICAgICAgICAgImRlc2NyaXB0aW9uIjogIkJvb2sgcmVzcG9uc2UuIiwKICAgICAgICAgICAgInNjaGVtYSI6IHsKICAgICAgICAgICAgICAidHlwZSI6ICJzdHJpbmciLAogICAgICAgICAgICAgICIkcmVmIjogIiMvZGVmaW5pdGlvbnMvYm9vayIKICAgICAgICAgICAgfQogICAgICAgICAgfQogICAgICAgIH0KICAgICAgfSwKICAgICAgImRlbGV0ZSI6IHsKICAgICAgICAiZGVzY3JpcHRpb24iOiAiRGVsZXRlcyBhIGJvb2sgaXRlbSBmcm9tIHRoZSBib29rc3RvcmUuIiwKICAgICAgICAib3BlcmF0aW9uSWQiOiAiZGVsZXRlQm9vayIsCiAgICAgICAgInByb2R1Y2VzIjogWwogICAgICAgICAgImFwcGxpY2F0aW9uL2pzb24iCiAgICAgICAgXSwKICAgICAgICAicGFyYW1ldGVycyI6IFt7CiAgICAgICAgICAibmFtZSI6ICJpZCIsCiAgICAgICAgICAiaW4iOiAicGF0aCIsCiAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiQSBzcGVjaWZpYyBJRCBvZiBhIGJvb2sgaXRlbSB0byBkZWxldGUuIiwKICAgICAgICAgICJyZXF1aXJlZCI6IHRydWUsCiAgICAgICAgICAidHlwZSI6ICJpbnRlZ2VyIgogICAgICAgIH1dLAogICAgICAgICJyZXNwb25zZXMiOiB7CiAgICAgICAgICAiMjA0IjogewogICAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiQm9vayBkZWxldGVkIgogICAgICAgICAgfQogICAgICAgIH0KICAgICAgfQogICAgfQogIH0KfQ== importFileFormat: swagger importFileSource: BODY_BASE64 schema: additionalProperties: false description: Contains information about an API definition file to import. type: object required: - importFileFormat - importFileSource properties: contractId: description: The unique identifier for the contract under which to provision the endpoint. example: '{{contractId}}' type: string groupId: description: The unique identifier for the group under which to provision the endpoint. example: '{{groupId}}' type: number importFileContent: description: The content of the API definition file encoded in Base64 (see [RFC 4648](https://tools.ietf.org/html/rfc4648) for details). Specify this only if you set the corresponding `importFileSource` to `BODY_BASE64`. example: '{{importFileContent}}' type: string importFileFormat: description: The format of the API definition file, either `raml` or `swagger`. You cam import RAML 0.8 files and Swagger 2.0 or 3.0 files. example: '{{importFileFormat}}' type: string enum: - swagger - raml importFileSource: description: The location of the API definition file, either `URL` if you store the file on the web, or `BODY_BASE64` if you encode the file contents in the request body. example: '{{importFileSource}}' type: string enum: - URL - BODY_BASE64 importUrl: description: The URL from which to get the API definition file. Specify this only if you set the corresponding `importFileSource` to `URL`. example: '{{importUrl}}' type: string root: description: If the import file located at the `importUrl` is a ZIP archive, this identifies the API definition's filename within the archive. example: '{{root}}' type: string x-akamai: file-path: schemas/importFileDto.yaml responses: '200': description: Operation succeeded. content: application/json: example: akamaiSecurityRestrictions: null apiEndPointId: 492375 apiEndPointLocked: false apiEndPointName: Bookstore API apiEndPointScheme: http/https apiGatewayEnabled: true basePath: /bookstore caseSensitive: true clonedFromVersion: 1 consumeType: any contractId: C-0N7RAC7 createDate: 2019-06-12T13:06:52+0000 createdBy: mrossi description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. endpointHidden: false graphQL: false groupId: 44681 isGraphQL: false lockVersion: 2 positiveConstrainsEnabled: null productionStatus: null protectedByApiKey: true responseConstraintsEnabled: false source: null stagingStatus: null updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin versionHidden: false versionNumber: 1 apiCategoryIds: - 2 - 7 apiEndPointHosts: - bookstore.api.akamai.com availableActions: - DELETE - CLONE_ENDPOINT - ACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING productionVersion: lastError: null status: null timestamp: null versionNumber: null securityScheme: securitySchemeType: apikey securitySchemeDetail: apiKeyLocation: header apiKeyName: apikey stagingVersion: lastError: null status: null timestamp: null versionNumber: null apiResources: - apiResourceClonedFromId: null apiResourceId: 2926712 apiResourceLogicId: 118435 apiResourceName: books createDate: 2019-06-12T13:06:52+0000 createdBy: tyamada description: A book item within the bookstore API. link: null lockVersion: 2 private: false resourcePath: /books/{bookId} updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin apiResourceMethods: - apiResourceMethod: GET apiResourceMethodId: 341591 apiResourceMethodLogicId: 184404 apiParameters: - apiParamLogicId: 578116 apiParameterId: 1212945 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string apiResourceMethParamId: 494448 array: false pathParamLocationId: null response: false apiChildParameters: [] - apiResourceMethod: POST apiResourceMethodId: 341592 apiResourceMethodLogicId: 184405 apiParameters: - apiParamLogicId: 578117 apiParameterId: 1212946 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterType: string apiResourceMethParamId: 494449 array: false pathParamLocationId: null response: false apiChildParameters: [] apiParameterRestriction: arrayRestriction: null numberRangeRestriction: null rangeRestriction: null xmlConversionRule: null lengthRestriction: lengthMax: 15 lengthMin: 3 schema: additionalProperties: false description: Contains information about an endpoint and its associated resources. type: object required: - apiEndPointName - apiEndPointHosts - groupId - contractId - lockVersion properties: akamaiSecurityRestrictions: additionalProperties: false description: 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. nullable: true type: object 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_BODY_PARAMS: description: Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_HEADER_PARAMS: description: Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_HEAD: description: Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_OPTIONS: description: Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PATCH: description: Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_PARAMS: description: Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_RESOURCES: description: Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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 KSD security policies. Either `1` for enabled security constraints, or `0` for disabled. type: integer enum: - 0 - 1 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. nullable: true type: integer enum: - 1 - 2 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`. type: integer enum: - 0 - 1 apiCategoryIds: description: The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints. nullable: true type: array items: type: integer apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint. minItems: 1 type: array items: type: string apiEndPointId: description: The unique identifier for the endpoint. nullable: true readOnly: true type: integer apiEndPointLocked: description: 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. nullable: true type: string enum: - http - https - http/https apiEndPointVersion: description: 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 apiResources: description: The list of resources assigned to the endpoint. nullable: true type: array items: additionalProperties: false description: Contains information about a resource assigned to an endpoint. type: object required: - apiResourceName - resourcePath 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: The list of HTTP methods the resource may respond to. type: array items: type: string apiResourceMethods: description: The list of HTTP methods the resource may respond to. type: array items: additionalProperties: false description: Contains information about an HTTP method to which a resource may respond. type: object required: - apiResourceMethod properties: apiParameters: description: The list of parameter objects assigned to the method. nullable: true type: array items: additionalProperties: false description: Contains information about a method's parameter. type: object required: - apiParameterName - apiParameterType - apiParameterRequired - apiParameterLocation properties: apiChildParameters: description: The collection of child JSON members or XML elements for JSON or XML body type parameters. type: array items: description: A further nested endpoint object. type: object x-akamai: file-path: schemas/apiParameterDto-nested.yaml apiParamLogicId: description: The unique identifier for the parameter across all endpoint versions. readOnly: true type: integer apiParameterContentType: description: The content type of the parameter. Only applicable for top level body parameters. type: string enum: - json - xml - urlencoded - json/xml - any - none apiParameterId: description: 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. type: string enum: - query - body - header - path - cookie 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: Contains information about restrictions and XML representation rules specified for the parameter. nullable: true type: object properties: arrayRestriction: additionalProperties: false description: Contains information about array restrictions for array type parameters. Define this object only if you enabled the corresponding `array` member. nullable: true type: object 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. type: string enum: - csv - ssv - tsv - pipes - multi maxItems: description: The maximum allowed number of array items. type: integer minItems: description: The minimum allowed number of array items. type: integer uniqueItems: description: Whether the array contains only unique items. type: boolean lengthRestriction: additionalProperties: false description: Contains information about length restrictions for string type parameters. nullable: true type: object 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 numberRangeRestriction: additionalProperties: false description: Contains information about range restrictions for number type parameters. nullable: true type: object properties: numberRangeMax: description: The maximum range restriction. nullable: true type: number numberRangeMin: description: The minimum range restriction. nullable: true type: number rangeRestriction: additionalProperties: false description: Contains information about range restrictions for integer type parameters. nullable: true type: object properties: rangeMax: description: The maximum range restriction. nullable: true type: integer rangeMin: description: The minimum range restriction. nullable: true type: integer responseRestriction: additionalProperties: false type: object 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. type: string enum: - SIZE_6K - SIZE_8K - SIZE_12K - NO_LIMIT 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. nullable: true type: array items: type: integer xmlConversionRule: additionalProperties: false description: Contains information about an XML representation of a JSON-encoded parameter. nullable: true type: object 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 x-akamai: file-path: schemas/xmlRestrictionDto.yaml apiParameterType: description: The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects. type: string enum: - string - integer - number - boolean - json/xml apiResourceMethParamId: description: 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 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: number response: description: Whether the parameter is within a response type. type: boolean x-akamai: file-path: schemas/apiParameterDto.yaml apiResourceMethod: description: The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`. type: string enum: - GET - PUT - POST - DELETE - HEAD - PATCH - OPTIONS apiResourceMethodId: description: The unique identifier for the resource's allowed method. nullable: true readOnly: true type: integer apiResourceMethodLogicId: description: The unique identifier for the resource's method across all endpoint versions. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiMethodParametersDto.yaml apiResourceName: description: The name of the resource. type: string createDate: description: The ISO 6801 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. 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: number 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 6801 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 x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml apiSource: description: Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`. nullable: true type: string enum: - USER - API_DISCOVERY apiVersionInfo: additionalProperties: false description: 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. nullable: true type: object required: - location properties: location: description: The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter. type: string enum: - HEADER - BASE_PATH - QUERY 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 x-akamai: file-path: schemas/apiVersionInfo.yaml availableActions: description: The collection of available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2). minItems: 0 nullable: true readOnly: true type: array items: type: string 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 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: 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. nullable: true type: string enum: - none - json - xml - json/xml - any - urlencoded - json/urlencoded - xml/urlencoded - json/xml/urlencoded contractId: description: 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: The ISO 6801 timestamp indicating when you created the endpoint. format: date-time nullable: true readOnly: true type: string createdBy: description: 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: The collection of personally identifiable information (PII) in your API parameters discovered by the network. nullable: true type: array items: type: integer endpointHidden: description: 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: 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: 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 KSD firewall policies are enabled for the endpoint. nullable: true type: boolean productionStatus: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED productionVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the production network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml protectedByApiKey: description: Whether you enabled API key protection for the endpoint version by making the version private. readOnly: true type: boolean responseConstraintsEnabled: description: 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: Contains information about the key with which users may access the endpoint. nullable: true type: object properties: securitySchemeDetail: additionalProperties: false description: Contains information about the location of the API key. type: object properties: apiKeyLocation: description: The location of the API key in incoming requests, either `cookie`, `header`, or `query` parameter. type: string enum: - cookie - header - query apiKeyName: description: The name of the header, query parameter, or cookie where you located the API key. type: string securitySchemeType: description: The type of security scheme implemented for the endpoint. The only valid value is `apikey`. type: string enum: - apikey source: additionalProperties: false description: Contains information about the import file used to create the endpoint. nullable: true readOnly: true type: object properties: apiVersion: description: The major version of the API defined in the import file. nullable: true readOnly: true type: string specificationVersion: description: The version of the import file's specification. example: 3.0.0 nullable: true readOnly: true type: string type: description: The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`. nullable: true readOnly: true type: string enum: - SWAGGER - RAML x-akamai: file-path: schemas/apiEndpointSourceDto.yaml stagingStatus: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the staging network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml updateDate: description: The ISO 6801 timestamp indicating when you last modified the endpoint. format: date-time nullable: true readOnly: true type: string updatedBy: description: The identifier for the user who last modified the endpoint. nullable: true readOnly: true type: string versionHidden: description: 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 x-akamai: file-path: schemas/apiEndpointWithResourceDto-recurse.yaml '400': description: Some of the file input data is invalid. content: application/json: example: apiEndpointDetails: akamaiSecurityRestrictions: null apiCategoryIds: null apiEndPointId: null apiEndPointLocked: null apiEndPointName: Bookstore API apiEndPointScheme: http/https apiProtectVersion: null basePath: /bookstore clonedFromVersion: null consumeType: any contractId: null createDate: null createdBy: null description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. groupId: null lockVersion: -1 productionStatus: null productionVersion: null protectedByApiKey: false securityScheme: null stagingStatus: null stagingVersion: null updateDate: null updatedBy: null versionNumber: null apiEndPointHosts: - bookstore.api.akamai.com apiResources: [] problems: - detail: 'The object instance has properties which are not allowed by the schema: ["unrecognizable"]' domain: validation keyword: additionalProperties level: error pointer: /paths/books/post title: Invalid schema type: /api-definitions/error-types/IMPORT-INVALID-SCHEMA schema: additionalProperties: false description: Contains information about a result of an import operation, including endpoint details and a list of potential issues. type: object properties: apiEndpointDetails: additionalProperties: false description: Contains information about the imported endpoint. type: object required: - apiEndPointName - apiEndPointHosts - groupId - contractId - lockVersion properties: akamaiSecurityRestrictions: additionalProperties: false description: 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. nullable: true type: object 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_BODY_PARAMS: description: Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_HEADER_PARAMS: description: Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_HEAD: description: Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_OPTIONS: description: Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PATCH: description: Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_PARAMS: description: Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_RESOURCES: description: Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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 KSD security policies. Either `1` for enabled security constraints, or `0` for disabled. type: integer enum: - 0 - 1 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. nullable: true type: integer enum: - 1 - 2 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`. type: integer enum: - 0 - 1 apiCategoryIds: description: The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints. nullable: true type: array items: type: integer apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint. minItems: 1 type: array items: type: string apiEndPointId: description: The unique identifier for the endpoint. nullable: true readOnly: true type: integer apiEndPointLocked: description: 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. nullable: true type: string enum: - http - https - http/https apiEndPointVersion: description: 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 apiResources: description: The list of resources assigned to the endpoint. nullable: true type: array items: additionalProperties: false description: Contains information about a resource assigned to an endpoint. type: object required: - apiResourceName - resourcePath 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: The list of HTTP methods the resource may respond to. type: array items: type: string apiResourceMethods: description: The list of HTTP methods the resource may respond to. type: array items: additionalProperties: false description: Contains information about an HTTP method to which a resource may respond. type: object required: - apiResourceMethod properties: apiParameters: description: The list of parameter objects assigned to the method. nullable: true type: array items: additionalProperties: false description: Contains information about a method's parameter. type: object required: - apiParameterName - apiParameterType - apiParameterRequired - apiParameterLocation properties: apiChildParameters: description: The collection of child JSON members or XML elements for JSON or XML body type parameters. type: array items: description: A further nested endpoint object. type: object x-akamai: file-path: schemas/apiParameterDto-nested.yaml apiParamLogicId: description: The unique identifier for the parameter across all endpoint versions. readOnly: true type: integer apiParameterContentType: description: The content type of the parameter. Only applicable for top level body parameters. type: string enum: - json - xml - urlencoded - json/xml - any - none apiParameterId: description: 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. type: string enum: - query - body - header - path - cookie 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: Contains information about restrictions and XML representation rules specified for the parameter. nullable: true type: object properties: arrayRestriction: additionalProperties: false description: Contains information about array restrictions for array type parameters. Define this object only if you enabled the corresponding `array` member. nullable: true type: object 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. type: string enum: - csv - ssv - tsv - pipes - multi maxItems: description: The maximum allowed number of array items. type: integer minItems: description: The minimum allowed number of array items. type: integer uniqueItems: description: Whether the array contains only unique items. type: boolean lengthRestriction: additionalProperties: false description: Contains information about length restrictions for string type parameters. nullable: true type: object 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 numberRangeRestriction: additionalProperties: false description: Contains information about range restrictions for number type parameters. nullable: true type: object properties: numberRangeMax: description: The maximum range restriction. nullable: true type: number numberRangeMin: description: The minimum range restriction. nullable: true type: number rangeRestriction: additionalProperties: false description: Contains information about range restrictions for integer type parameters. nullable: true type: object properties: rangeMax: description: The maximum range restriction. nullable: true type: integer rangeMin: description: The minimum range restriction. nullable: true type: integer responseRestriction: additionalProperties: false type: object 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. type: string enum: - SIZE_6K - SIZE_8K - SIZE_12K - NO_LIMIT 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. nullable: true type: array items: type: integer xmlConversionRule: additionalProperties: false description: Contains information about an XML representation of a JSON-encoded parameter. nullable: true type: object 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 x-akamai: file-path: schemas/xmlRestrictionDto.yaml apiParameterType: description: The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects. type: string enum: - string - integer - number - boolean - json/xml apiResourceMethParamId: description: 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 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: number response: description: Whether the parameter is within a response type. type: boolean x-akamai: file-path: schemas/apiParameterDto.yaml apiResourceMethod: description: The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`. type: string enum: - GET - PUT - POST - DELETE - HEAD - PATCH - OPTIONS apiResourceMethodId: description: The unique identifier for the resource's allowed method. nullable: true readOnly: true type: integer apiResourceMethodLogicId: description: The unique identifier for the resource's method across all endpoint versions. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiMethodParametersDto.yaml apiResourceName: description: The name of the resource. type: string createDate: description: The ISO 6801 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. 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: number 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 6801 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 x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml apiSource: description: Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`. nullable: true type: string enum: - USER - API_DISCOVERY apiVersionInfo: additionalProperties: false description: 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. nullable: true type: object required: - location properties: location: description: The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter. type: string enum: - HEADER - BASE_PATH - QUERY 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 x-akamai: file-path: schemas/apiVersionInfo.yaml availableActions: description: The collection of available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2). minItems: 0 nullable: true readOnly: true type: array items: type: string 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 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: 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. nullable: true type: string enum: - none - json - xml - json/xml - any - urlencoded - json/urlencoded - xml/urlencoded - json/xml/urlencoded contractId: description: 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: The ISO 6801 timestamp indicating when you created the endpoint. format: date-time nullable: true readOnly: true type: string createdBy: description: 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: The collection of personally identifiable information (PII) in your API parameters discovered by the network. nullable: true type: array items: type: integer endpointHidden: description: 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: 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: 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 KSD firewall policies are enabled for the endpoint. nullable: true type: boolean productionStatus: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED productionVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the production network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml protectedByApiKey: description: Whether you enabled API key protection for the endpoint version by making the version private. readOnly: true type: boolean responseConstraintsEnabled: description: 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: Contains information about the key with which users may access the endpoint. nullable: true type: object properties: securitySchemeDetail: additionalProperties: false description: Contains information about the location of the API key. type: object properties: apiKeyLocation: description: The location of the API key in incoming requests, either `cookie`, `header`, or `query` parameter. type: string enum: - cookie - header - query apiKeyName: description: The name of the header, query parameter, or cookie where you located the API key. type: string securitySchemeType: description: The type of security scheme implemented for the endpoint. The only valid value is `apikey`. type: string enum: - apikey source: additionalProperties: false description: Contains information about the import file used to create the endpoint. nullable: true readOnly: true type: object properties: apiVersion: description: The major version of the API defined in the import file. nullable: true readOnly: true type: string specificationVersion: description: The version of the import file's specification. example: 3.0.0 nullable: true readOnly: true type: string type: description: The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`. nullable: true readOnly: true type: string enum: - SWAGGER - RAML x-akamai: file-path: schemas/apiEndpointSourceDto.yaml stagingStatus: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the staging network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml updateDate: description: The ISO 6801 timestamp indicating when you last modified the endpoint. format: date-time nullable: true readOnly: true type: string updatedBy: description: The identifier for the user who last modified the endpoint. nullable: true readOnly: true type: string versionHidden: description: 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 x-akamai: file-path: schemas/apiEndpointWithResourceDto-recurse.yaml problems: description: The list of problems that occurred during the import, such as schema errors or unsupported property warnings. type: array items: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml x-akamai: file-path: schemas/importResult.yaml 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /endpoints/{apiEndPointId}/versions/{versionNumber}/hide: parameters: - description: The unique identifier for the endpoint version. example: '{{versionNumber}}' in: path name: versionNumber required: true schema: example: 1 type: integer x-akamai: file-path: parameters/versionNumber-path.yaml - description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' in: path name: apiEndPointId required: true schema: example: 1 type: integer x-akamai: file-path: parameters/apiEndPointId-path.yaml post: description: Hides an endpoint version. You can only hide inactive or deactivated versions. You can't activate or delete hidden versions. A hidden endpoint version appears in the [List versions](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-versions) operation's response object with the `hidden` parameter set to `true`. Running this operation affects the version listing in the API Definitions user interface. operationId: post-endpoint-version-hide summary: Hide a version tags: - Versions 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-hide responses: '200': description: Operation succeeded. content: application/json: example: akamaiSecurityRestrictions: null apiEndPointId: 492375 apiEndPointLocked: false apiEndPointName: Bookstore API apiEndPointScheme: http/https apiGatewayEnabled: true basePath: /bookstore caseSensitive: true clonedFromVersion: 1 consumeType: any contractId: K-0N7RAK71 createDate: 2019-06-12T13:06:52+0000 createdBy: tyamada description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. endpointHidden: false graphQL: false groupId: 44681 isGraphQL: false lockVersion: 2 positiveConstrainsEnabled: null productionStatus: null protectedByApiKey: true responseConstraintsEnabled: false source: null stagingStatus: null updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin versionHidden: false versionNumber: 1 apiCategoryIds: - 2 - 7 apiEndPointHosts: - bookstore.api.akamai.com availableActions: - DELETE - CLONE_ENDPOINT - ACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING productionVersion: lastError: null status: null timestamp: null versionNumber: null securityScheme: securitySchemeType: apikey securitySchemeDetail: apiKeyLocation: header apiKeyName: apikey stagingVersion: lastError: null status: null timestamp: null versionNumber: null apiResources: - apiResourceClonedFromId: null apiResourceId: 2926712 apiResourceLogicId: 118435 apiResourceName: books createDate: 2019-06-12T13:06:52+0000 createdBy: alfulani description: A book item within the bookstore API. link: null lockVersion: 2 private: false resourcePath: /books/{bookId} updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin apiResourceMethods: - apiResourceMethod: GET apiResourceMethodId: 341591 apiResourceMethodLogicId: 184404 apiParameters: - apiParamLogicId: 578116 apiParameterId: 1212945 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string apiResourceMethParamId: 494448 array: false pathParamLocationId: null response: false apiChildParameters: [] - apiResourceMethod: POST apiResourceMethodId: 341592 apiResourceMethodLogicId: 184405 apiParameters: - apiParamLogicId: 578117 apiParameterId: 1212946 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterType: string apiResourceMethParamId: 494449 array: false pathParamLocationId: null response: false apiChildParameters: [] apiParameterRestriction: arrayRestriction: null numberRangeRestriction: null rangeRestriction: null xmlConversionRule: null lengthRestriction: lengthMax: 15 lengthMin: 3 schema: additionalProperties: false description: Contains information about an endpoint and its associated resources. type: object required: - apiEndPointName - apiEndPointHosts - groupId - contractId - lockVersion properties: akamaiSecurityRestrictions: additionalProperties: false description: 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. nullable: true type: object 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_BODY_PARAMS: description: Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_HEADER_PARAMS: description: Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_HEAD: description: Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_OPTIONS: description: Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PATCH: description: Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_PARAMS: description: Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_RESOURCES: description: Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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 KSD security policies. Either `1` for enabled security constraints, or `0` for disabled. type: integer enum: - 0 - 1 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. nullable: true type: integer enum: - 1 - 2 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`. type: integer enum: - 0 - 1 apiCategoryIds: description: The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints. nullable: true type: array items: type: integer apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint. minItems: 1 type: array items: type: string apiEndPointId: description: The unique identifier for the endpoint. nullable: true readOnly: true type: integer apiEndPointLocked: description: 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. nullable: true type: string enum: - http - https - http/https apiEndPointVersion: description: 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 apiResources: description: The list of resources assigned to the endpoint. nullable: true type: array items: additionalProperties: false description: Contains information about a resource assigned to an endpoint. type: object required: - apiResourceName - resourcePath 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: The list of HTTP methods the resource may respond to. type: array items: type: string apiResourceMethods: description: The list of HTTP methods the resource may respond to. type: array items: additionalProperties: false description: Contains information about an HTTP method to which a resource may respond. type: object required: - apiResourceMethod properties: apiParameters: description: The list of parameter objects assigned to the method. nullable: true type: array items: additionalProperties: false description: Contains information about a method's parameter. type: object required: - apiParameterName - apiParameterType - apiParameterRequired - apiParameterLocation properties: apiChildParameters: description: The collection of child JSON members or XML elements for JSON or XML body type parameters. type: array items: description: A further nested endpoint object. type: object x-akamai: file-path: schemas/apiParameterDto-nested.yaml apiParamLogicId: description: The unique identifier for the parameter across all endpoint versions. readOnly: true type: integer apiParameterContentType: description: The content type of the parameter. Only applicable for top level body parameters. type: string enum: - json - xml - urlencoded - json/xml - any - none apiParameterId: description: 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. type: string enum: - query - body - header - path - cookie 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: Contains information about restrictions and XML representation rules specified for the parameter. nullable: true type: object properties: arrayRestriction: additionalProperties: false description: Contains information about array restrictions for array type parameters. Define this object only if you enabled the corresponding `array` member. nullable: true type: object 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. type: string enum: - csv - ssv - tsv - pipes - multi maxItems: description: The maximum allowed number of array items. type: integer minItems: description: The minimum allowed number of array items. type: integer uniqueItems: description: Whether the array contains only unique items. type: boolean lengthRestriction: additionalProperties: false description: Contains information about length restrictions for string type parameters. nullable: true type: object 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 numberRangeRestriction: additionalProperties: false description: Contains information about range restrictions for number type parameters. nullable: true type: object properties: numberRangeMax: description: The maximum range restriction. nullable: true type: number numberRangeMin: description: The minimum range restriction. nullable: true type: number rangeRestriction: additionalProperties: false description: Contains information about range restrictions for integer type parameters. nullable: true type: object properties: rangeMax: description: The maximum range restriction. nullable: true type: integer rangeMin: description: The minimum range restriction. nullable: true type: integer responseRestriction: additionalProperties: false type: object 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. type: string enum: - SIZE_6K - SIZE_8K - SIZE_12K - NO_LIMIT 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. nullable: true type: array items: type: integer xmlConversionRule: additionalProperties: false description: Contains information about an XML representation of a JSON-encoded parameter. nullable: true type: object 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 x-akamai: file-path: schemas/xmlRestrictionDto.yaml apiParameterType: description: The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects. type: string enum: - string - integer - number - boolean - json/xml apiResourceMethParamId: description: 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 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: number response: description: Whether the parameter is within a response type. type: boolean x-akamai: file-path: schemas/apiParameterDto.yaml apiResourceMethod: description: The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`. type: string enum: - GET - PUT - POST - DELETE - HEAD - PATCH - OPTIONS apiResourceMethodId: description: The unique identifier for the resource's allowed method. nullable: true readOnly: true type: integer apiResourceMethodLogicId: description: The unique identifier for the resource's method across all endpoint versions. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiMethodParametersDto.yaml apiResourceName: description: The name of the resource. type: string createDate: description: The ISO 6801 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. 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: number 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 6801 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 x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml apiSource: description: Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`. nullable: true type: string enum: - USER - API_DISCOVERY apiVersionInfo: additionalProperties: false description: 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. nullable: true type: object required: - location properties: location: description: The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter. type: string enum: - HEADER - BASE_PATH - QUERY 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 x-akamai: file-path: schemas/apiVersionInfo.yaml availableActions: description: The collection of available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2). minItems: 0 nullable: true readOnly: true type: array items: type: string 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 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: 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. nullable: true type: string enum: - none - json - xml - json/xml - any - urlencoded - json/urlencoded - xml/urlencoded - json/xml/urlencoded contractId: description: 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: The ISO 6801 timestamp indicating when you created the endpoint. format: date-time nullable: true readOnly: true type: string createdBy: description: 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: The collection of personally identifiable information (PII) in your API parameters discovered by the network. nullable: true type: array items: type: integer endpointHidden: description: 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: 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: 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 KSD firewall policies are enabled for the endpoint. nullable: true type: boolean productionStatus: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED productionVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the production network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml protectedByApiKey: description: Whether you enabled API key protection for the endpoint version by making the version private. readOnly: true type: boolean responseConstraintsEnabled: description: 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: Contains information about the key with which users may access the endpoint. nullable: true type: object properties: securitySchemeDetail: additionalProperties: false description: Contains information about the location of the API key. type: object properties: apiKeyLocation: description: The location of the API key in incoming requests, either `cookie`, `header`, or `query` parameter. type: string enum: - cookie - header - query apiKeyName: description: The name of the header, query parameter, or cookie where you located the API key. type: string securitySchemeType: description: The type of security scheme implemented for the endpoint. The only valid value is `apikey`. type: string enum: - apikey source: additionalProperties: false description: Contains information about the import file used to create the endpoint. nullable: true readOnly: true type: object properties: apiVersion: description: The major version of the API defined in the import file. nullable: true readOnly: true type: string specificationVersion: description: The version of the import file's specification. example: 3.0.0 nullable: true readOnly: true type: string type: description: The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`. nullable: true readOnly: true type: string enum: - SWAGGER - RAML x-akamai: file-path: schemas/apiEndpointSourceDto.yaml stagingStatus: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the staging network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml updateDate: description: The ISO 6801 timestamp indicating when you last modified the endpoint. format: date-time nullable: true readOnly: true type: string updatedBy: description: The identifier for the user who last modified the endpoint. nullable: true readOnly: true type: string versionHidden: description: 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 x-akamai: file-path: schemas/apiEndpointWithResourceDto-recurse.yaml '400': description: Invalid data input. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '403': description: You don't have access to the endpoint. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /endpoints/{apiEndPointId}/versions/{versionNumber}/show: parameters: - description: The unique identifier for the endpoint version. example: '{{versionNumber}}' in: path name: versionNumber required: true schema: example: 1 type: integer x-akamai: file-path: parameters/versionNumber-path.yaml - description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' in: path name: apiEndPointId required: true schema: example: 1 type: integer x-akamai: file-path: parameters/apiEndPointId-path.yaml post: description: Reveals a hidden endpoint version. A revealed endpoint version appears in the [List versions](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-versions) operation's response object with the `hidden` parameter set to `false`. Running this operation affects the version listing in the API Definitions user interface. operationId: post-version-show summary: Show a version tags: - Versions externalDocs: description: See documentation for this operation in Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference/post-version-show responses: '200': description: Operation succeeded. content: application/json: example: akamaiSecurityRestrictions: null apiEndPointId: 492375 apiEndPointLocked: false apiEndPointName: Bookstore API apiEndPointScheme: http/https apiGatewayEnabled: true basePath: /bookstore caseSensitive: true clonedFromVersion: 1 consumeType: any contractId: K-0N7RAK7 createDate: 2019-06-12T13:06:52+0000 createdBy: mrossi description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. endpointHidden: false graphQL: false groupId: 44681 isGraphQL: false lockVersion: 2 positiveConstrainsEnabled: null productionStatus: null protectedByApiKey: true responseConstraintsEnabled: false source: null stagingStatus: null updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin versionHidden: false versionNumber: 1 apiCategoryIds: - 2 - 7 apiEndPointHosts: - bookstore.api.akamai.com availableActions: - DELETE - CLONE_ENDPOINT - ACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING productionVersion: lastError: null status: null timestamp: null versionNumber: null securityScheme: securitySchemeType: apikey securitySchemeDetail: apiKeyLocation: header apiKeyName: apikey stagingVersion: lastError: null status: null timestamp: null versionNumber: null apiResources: - apiResourceClonedFromId: null apiResourceId: 2926712 apiResourceLogicId: 118435 apiResourceName: books createDate: 2019-06-12T13:06:52+0000 createdBy: mrossi description: A book item within the bookstore API. link: null lockVersion: 2 private: false resourcePath: /books/{bookId} updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin apiResourceMethods: - apiResourceMethod: GET apiResourceMethodId: 341591 apiResourceMethodLogicId: 184404 apiParameters: - apiParamLogicId: 578116 apiParameterId: 1212945 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string apiResourceMethParamId: 494448 array: false pathParamLocationId: null response: false apiChildParameters: [] - apiResourceMethod: POST apiResourceMethodId: 341592 apiResourceMethodLogicId: 184405 apiParameters: - apiParamLogicId: 578117 apiParameterId: 1212946 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterType: string apiResourceMethParamId: 494449 array: false pathParamLocationId: null response: false apiChildParameters: [] apiParameterRestriction: arrayRestriction: null numberRangeRestriction: null rangeRestriction: null xmlConversionRule: null lengthRestriction: lengthMax: 15 lengthMin: 3 schema: additionalProperties: false description: Contains information about an endpoint and its associated resources. type: object required: - apiEndPointName - apiEndPointHosts - groupId - contractId - lockVersion properties: akamaiSecurityRestrictions: additionalProperties: false description: 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. nullable: true type: object 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_BODY_PARAMS: description: Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_HEADER_PARAMS: description: Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_HEAD: description: Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_OPTIONS: description: Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PATCH: description: Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_PARAMS: description: Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_RESOURCES: description: Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 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. type: integer enum: - 0 - 1 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 KSD security policies. Either `1` for enabled security constraints, or `0` for disabled. type: integer enum: - 0 - 1 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. nullable: true type: integer enum: - 1 - 2 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`. type: integer enum: - 0 - 1 apiCategoryIds: description: The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints. nullable: true type: array items: type: integer apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint. minItems: 1 type: array items: type: string apiEndPointId: description: The unique identifier for the endpoint. nullable: true readOnly: true type: integer apiEndPointLocked: description: 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. nullable: true type: string enum: - http - https - http/https apiEndPointVersion: description: 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 apiResources: description: The list of resources assigned to the endpoint. nullable: true type: array items: additionalProperties: false description: Contains information about a resource assigned to an endpoint. type: object required: - apiResourceName - resourcePath 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: The list of HTTP methods the resource may respond to. type: array items: type: string apiResourceMethods: description: The list of HTTP methods the resource may respond to. type: array items: additionalProperties: false description: Contains information about an HTTP method to which a resource may respond. type: object required: - apiResourceMethod properties: apiParameters: description: The list of parameter objects assigned to the method. nullable: true type: array items: additionalProperties: false description: Contains information about a method's parameter. type: object required: - apiParameterName - apiParameterType - apiParameterRequired - apiParameterLocation properties: apiChildParameters: description: The collection of child JSON members or XML elements for JSON or XML body type parameters. type: array items: description: A further nested endpoint object. type: object x-akamai: file-path: schemas/apiParameterDto-nested.yaml apiParamLogicId: description: The unique identifier for the parameter across all endpoint versions. readOnly: true type: integer apiParameterContentType: description: The content type of the parameter. Only applicable for top level body parameters. type: string enum: - json - xml - urlencoded - json/xml - any - none apiParameterId: description: 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. type: string enum: - query - body - header - path - cookie 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: Contains information about restrictions and XML representation rules specified for the parameter. nullable: true type: object properties: arrayRestriction: additionalProperties: false description: Contains information about array restrictions for array type parameters. Define this object only if you enabled the corresponding `array` member. nullable: true type: object 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. type: string enum: - csv - ssv - tsv - pipes - multi maxItems: description: The maximum allowed number of array items. type: integer minItems: description: The minimum allowed number of array items. type: integer uniqueItems: description: Whether the array contains only unique items. type: boolean lengthRestriction: additionalProperties: false description: Contains information about length restrictions for string type parameters. nullable: true type: object 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 numberRangeRestriction: additionalProperties: false description: Contains information about range restrictions for number type parameters. nullable: true type: object properties: numberRangeMax: description: The maximum range restriction. nullable: true type: number numberRangeMin: description: The minimum range restriction. nullable: true type: number rangeRestriction: additionalProperties: false description: Contains information about range restrictions for integer type parameters. nullable: true type: object properties: rangeMax: description: The maximum range restriction. nullable: true type: integer rangeMin: description: The minimum range restriction. nullable: true type: integer responseRestriction: additionalProperties: false type: object 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. type: string enum: - SIZE_6K - SIZE_8K - SIZE_12K - NO_LIMIT 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. nullable: true type: array items: type: integer xmlConversionRule: additionalProperties: false description: Contains information about an XML representation of a JSON-encoded parameter. nullable: true type: object 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 x-akamai: file-path: schemas/xmlRestrictionDto.yaml apiParameterType: description: The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects. type: string enum: - string - integer - number - boolean - json/xml apiResourceMethParamId: description: 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 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: number response: description: Whether the parameter is within a response type. type: boolean x-akamai: file-path: schemas/apiParameterDto.yaml apiResourceMethod: description: The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`. type: string enum: - GET - PUT - POST - DELETE - HEAD - PATCH - OPTIONS apiResourceMethodId: description: The unique identifier for the resource's allowed method. nullable: true readOnly: true type: integer apiResourceMethodLogicId: description: The unique identifier for the resource's method across all endpoint versions. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiMethodParametersDto.yaml apiResourceName: description: The name of the resource. type: string createDate: description: The ISO 6801 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. 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: number 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 6801 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 x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml apiSource: description: Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`. nullable: true type: string enum: - USER - API_DISCOVERY apiVersionInfo: additionalProperties: false description: 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. nullable: true type: object required: - location properties: location: description: The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter. type: string enum: - HEADER - BASE_PATH - QUERY 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 x-akamai: file-path: schemas/apiVersionInfo.yaml availableActions: description: The collection of available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2). minItems: 0 nullable: true readOnly: true type: array items: type: string 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 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: 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. nullable: true type: string enum: - none - json - xml - json/xml - any - urlencoded - json/urlencoded - xml/urlencoded - json/xml/urlencoded contractId: description: 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: The ISO 6801 timestamp indicating when you created the endpoint. format: date-time nullable: true readOnly: true type: string createdBy: description: 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: The collection of personally identifiable information (PII) in your API parameters discovered by the network. nullable: true type: array items: type: integer endpointHidden: description: 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: 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: 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 KSD firewall policies are enabled for the endpoint. nullable: true type: boolean productionStatus: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED productionVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the production network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml protectedByApiKey: description: Whether you enabled API key protection for the endpoint version by making the version private. readOnly: true type: boolean responseConstraintsEnabled: description: 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: Contains information about the key with which users may access the endpoint. nullable: true type: object properties: securitySchemeDetail: additionalProperties: false description: Contains information about the location of the API key. type: object properties: apiKeyLocation: description: The location of the API key in incoming requests, either `cookie`, `header`, or `query` parameter. type: string enum: - cookie - header - query apiKeyName: description: The name of the header, query parameter, or cookie where you located the API key. type: string securitySchemeType: description: The type of security scheme implemented for the endpoint. The only valid value is `apikey`. type: string enum: - apikey source: additionalProperties: false description: Contains information about the import file used to create the endpoint. nullable: true readOnly: true type: object properties: apiVersion: description: The major version of the API defined in the import file. nullable: true readOnly: true type: string specificationVersion: description: The version of the import file's specification. example: 3.0.0 nullable: true readOnly: true type: string type: description: The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`. nullable: true readOnly: true type: string enum: - SWAGGER - RAML x-akamai: file-path: schemas/apiEndpointSourceDto.yaml stagingStatus: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the staging network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: 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. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml updateDate: description: The ISO 6801 timestamp indicating when you last modified the endpoint. format: date-time nullable: true readOnly: true type: string updatedBy: description: The identifier for the user who last modified the endpoint. nullable: true readOnly: true type: string versionHidden: description: 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 x-akamai: file-path: schemas/apiEndpointWithResourceDto-recurse.yaml '400': description: Invalid data input. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '403': description: You don't have access to the endpoint. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /ids/{edgeWorkerId}/versions: parameters: - description: Unique identifier for an EdgeWorker. example: '{{edgeWorkerId}}' in: path name: edgeWorkerId required: true schema: example: 42 minimum: 1 type: integer x-akamai: file-path: parameters/edgeWorkerId-path.yaml post: description: Create a new version of an EdgeWorker. In order to run this operation you need to build an [EdgeWorkers code bundle](https://techdocs.akamai.com/edgeworkers/docs/create-a-code-bundle) and save it in GZIP format. You need to provide the GZIP binary file in the request body, with a `Content-Type` of `application/gzip`. operationId: post-versions summary: Akamai Create a New Version tags: - Versions externalDocs: description: See documentation for this operation in Akamai's EdgeWorkers API url: https://techdocs.akamai.com/edgeworkers/reference/post-versions requestBody: required: true content: application/gzip: schema: format: binary type: string responses: '201': description: Provides details for an EdgeWorker version. content: application/json: example: accountId: A-CCT5678 checksum: de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b3 createdBy: jsmith createdTime: '2020-07-05T18:17:46Z' edgeWorkerId: 42 version: '5' schema: additionalProperties: false type: object required: - edgeWorkerId - version - accountId - checksum - createdBy - createdTime properties: accountId: description: Identifier for the account where the EdgeWorker was created. minLength: 1 type: string checksum: description: A SHA-256 hash digest of the tarball. minLength: 1 type: string createdBy: description: Username of the person who created the EdgeWorker version. minLength: 1 type: string createdTime: description: ISO 8601 timestamp indicating when the EdgeWorker version was created. format: date-time type: string edgeWorkerId: description: Unique identifier of the EdgeWorker. minimum: 1 type: integer sequenceNumber: description: An incrementing number indicating the upload order of the EdgeWorker versions. minLength: 1 type: string version: description: Unique identifier of the EdgeWorker version. minLength: 1 type: string x-akamai: file-path: schemas/versions-post-201.yaml headers: Location: description: Use this URL to fetch the new resource. schema: type: string x-akamai: file-path: headers/Location.yaml 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string get: description: View a list of EdgeWorker versions. operationId: get-versions summary: Akamai List Versions tags: - Versions externalDocs: description: See documentation for this operation in Akamai's EdgeWorkers API url: https://techdocs.akamai.com/edgeworkers/reference/get-versions responses: '200': description: This section describes a list of EdgeWorker versions. content: application/json: example: versions: - accountId: A-CCT5678 checksum: de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b3 createdBy: jsmith createdTime: '2020-07-05T18:17:46Z' edgeWorkerId: 42 version: '1' - accountId: A-CCT9012 checksum: 8277e0910d750195b448797616e091ad616e091a createdBy: jsmith createdTime: '2020-07-05T23:01:34Z' edgeWorkerId: 42 version: '2' schema: additionalProperties: false type: object required: - versions properties: versions: description: List of EdgeWorker versions. minItems: 1 type: array items: additionalProperties: false type: object required: - edgeWorkerId - version - accountId - checksum - createdBy - createdTime properties: accountId: description: Identifier for the account where the EdgeWorker was created. minLength: 1 type: string checksum: description: A SHA-256 hash digest of the tarball. minLength: 1 type: string createdBy: description: Username of the person who created the EdgeWorker version. minLength: 1 type: string createdTime: description: ISO 8601 timestamp indicating when the EdgeWorker version was created. format: date-time type: string edgeWorkerId: description: Unique identifier of the EdgeWorker. minimum: 1 type: integer sequenceNumber: description: An incrementing number indicating the upload order of the EdgeWorker versions. minLength: 1 type: string version: description: Unique identifier of the EdgeWorker version. minLength: 1 type: string x-akamai: file-path: schemas/version-get-200.yaml x-akamai: file-path: schemas/versions-get-200.yaml 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /ids/{edgeWorkerId}/versions/{version}: parameters: - description: Unique identifier for an EdgeWorker version. example: '{{version}}' in: path name: version required: true schema: example: 5 type: integer x-akamai: file-path: parameters/version-path.yaml - description: Unique identifier for an EdgeWorker. example: '{{edgeWorkerId}}' in: path name: edgeWorkerId required: true schema: example: 42 minimum: 1 type: integer x-akamai: file-path: parameters/edgeWorkerId-path.yaml get: description: View details for a specific version. operationId: get-version summary: Akamai Get Version Details tags: - Versions externalDocs: description: See documentation for this operation in Akamai's EdgeWorkers API url: https://techdocs.akamai.com/edgeworkers/reference/get-version responses: '200': description: Provides details for an EdgeWorker version. content: application/json: example: accountId: A-CCT9012 checksum: de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b3 createdBy: jsmith createdTime: '2020-07-09T21:51:07Z' edgeWorkerId: 42 version: '3' schema: additionalProperties: false type: object required: - edgeWorkerId - version - accountId - checksum - createdBy - createdTime properties: accountId: description: Identifier for the account where the EdgeWorker was created. minLength: 1 type: string checksum: description: A SHA-256 hash digest of the tarball. minLength: 1 type: string createdBy: description: Username of the person who created the EdgeWorker version. minLength: 1 type: string createdTime: description: ISO 8601 timestamp indicating when the EdgeWorker version was created. format: date-time type: string edgeWorkerId: description: Unique identifier of the EdgeWorker. minimum: 1 type: integer sequenceNumber: description: An incrementing number indicating the upload order of the EdgeWorker versions. minLength: 1 type: string version: description: Unique identifier of the EdgeWorker version. minLength: 1 type: string x-akamai: file-path: schemas/version-get-200.yaml 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string delete: description: Delete a specific version. operationId: delete-version summary: Akamai Delete Version tags: - Versions externalDocs: description: See documentation for this operation in Akamai's EdgeWorkers API url: https://techdocs.akamai.com/edgeworkers/reference/delete-version responses: '204': description: Confirms the deletion of the EdgeWorker version. content: '*/*': {} 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /ids/{edgeWorkerId}/versions/{version}/content: parameters: - description: Unique identifier for an EdgeWorker version. example: '{{version}}' in: path name: version required: true schema: example: 5 type: integer x-akamai: file-path: parameters/version-path.yaml - description: Unique identifier for an EdgeWorker. example: '{{edgeWorkerId}}' in: path name: edgeWorkerId required: true schema: example: 42 minimum: 1 type: integer x-akamai: file-path: parameters/edgeWorkerId-path.yaml get: description: Download the bundle containing the code the EdgeWorker executes. operationId: get-version-content summary: Akamai Download an EdgeWorkers Code Bundle tags: - Versions externalDocs: description: See documentation for this operation in Akamai's EdgeWorkers API url: https://techdocs.akamai.com/edgeworkers/reference/get-version-content responses: '200': description: Downloaded EdgeWorkers code bundle. content: application/gzip: schema: format: binary type: string 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string externalDocs: description: See documentation for Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference x-readme: samples-languages: - curl - python - node