{ "components": { "parameters": { "contract-id-path": { "description": "The unique identifier for the contract.", "in": "path", "name": "contractId", "required": true, "schema": { "example": "K-0N7RAK7", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-path.yaml" } }, "group-id-path": { "description": "The unique identifier for the group.", "in": "path", "name": "groupId", "required": true, "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/group-id-path.yaml" } } }, "responses": { "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the resource.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "schemas": { "a-cg-picker-row": { "additionalProperties": false, "description": "A pairing of contract and group under which you provision the security and delivery settings for an endpoint.", "properties": { "acgId": { "description": "The unique identifier for the pairing of contract and group.", "type": "string" }, "contractId": { "description": "The unique identifier for the Akamai contract within the pairing.", "type": "string" }, "displayName": { "description": "The descriptive name for the pairing of contract and group.", "type": "string" }, "groupId": { "description": "The unique identifier for the group within the pairing.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/a-cg-picker-row.yaml" } }, "a-cg-picker-rows": { "description": "Pairings of contracts and groups under which you provision the security and delivery settings for an endpoint.", "items": { "additionalProperties": false, "description": "A pairing of contract and group under which you provision the security and delivery settings for an endpoint.", "properties": { "acgId": { "description": "The unique identifier for the pairing of contract and group.", "type": "string" }, "contractId": { "description": "The unique identifier for the Akamai contract within the pairing.", "type": "string" }, "displayName": { "description": "The descriptive name for the pairing of contract and group.", "type": "string" }, "groupId": { "description": "The unique identifier for the group within the pairing.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/a-cg-picker-row.yaml" } }, "type": "array", "x-akamai": { "file-path": "schemas/a-cg-picker-rows.yaml" } }, "acgs-host": { "additionalProperties": false, "description": "A hostname and access control group where the hostname is registered.", "properties": { "acgId": { "description": "The unique identifier for the access control group where the hostname is registered.", "type": "string" }, "contractId": { "description": "The unique identifier for the Akamai contract within the access control group.", "type": "string" }, "hostname": { "description": "The hostname that may receive traffic for an endpoint.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/acgs-host.yaml" } }, "acgs-hosts": { "description": "Hostnames assigned to an endpoint.", "items": { "additionalProperties": false, "description": "A hostname and access control group where the hostname is registered.", "properties": { "acgId": { "description": "The unique identifier for the access control group where the hostname is registered.", "type": "string" }, "contractId": { "description": "The unique identifier for the Akamai contract within the access control group.", "type": "string" }, "hostname": { "description": "The hostname that may receive traffic for an endpoint.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/acgs-host.yaml" } }, "type": "array", "x-akamai": { "file-path": "schemas/acgs-hosts.yaml" } }, "hosts-schema": { "description": "Hostnames assigned to an endpoint.", "items": { "type": "string" }, "type": "array", "x-akamai": { "file-path": "schemas/hosts-schema.yaml" } }, "http-problem-details": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } }, "http-problem-details-recurse": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } } } }, "externalDocs": { "description": "See documentation for Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference" }, "info": { "description": "Register and manage your APIs to enable security, delivery, and\ngovernance.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: API Endpoint Definition API", "version": "v2" }, "openapi": "3.0.0", "paths": { "/categories": { "post": { "description": "Creates a category that you can use to tag endpoints. The request's `apiCategoryName` needs to be unique per account.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/post-category" }, "operationId": "post-category", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "apiCategoryDescription": "The applications related to the Sales department.", "apiCategoryName": "Sales" }, "schema": { "additionalProperties": false, "description": "An endpoint category.", "properties": { "apiCategoryDescription": { "description": "The description of the category that you may use to tag related endpoints. If you specify `null` or an empty string in the request, the JSON response doesn't include this field.", "example": "{{apiCategoryDescription}}", "nullable": true, "type": "string" }, "apiCategoryId": { "description": "The unique identifier for the category.", "example": "{{apiCategoryId}}", "type": "integer" }, "apiCategoryName": { "description": "The unique-per-account name of the category. Any empty value reflects back as an `__UNCATEGORIZED__` keyword.", "example": "{{apiCategoryName}}", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the category.", "example": "{{createDate}}", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the category.", "example": "{{createdBy}}", "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "example": "{{link}}", "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.", "example": "{{lockVersion}}", "type": "integer" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the category.", "example": "{{updateDate}}", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the category.", "example": "{{updatedBy}}", "type": "string" }, "usageCount": { "description": "The number of endpoints that share the category.", "example": "{{usageCount}}", "type": "integer" } }, "required": [ "apiCategoryName" ], "type": "object", "x-akamai": { "file-path": "schemas/category-dto.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "apiCategoryDescription": "The applications related to the Sales department.", "apiCategoryId": 9902, "apiCategoryName": "Sales", "createDate": "2019-06-17T12:40:14+0000", "link": "/api-definitions/v2/categories/9902", "lockVersion": 0, "updateDate": "2019-06-17T12:40:14+0000" }, "schema": { "additionalProperties": false, "description": "An endpoint category.", "properties": { "apiCategoryDescription": { "description": "The description of the category that you may use to tag related endpoints. If you specify `null` or an empty string in the request, the JSON response doesn't include this field.", "nullable": true, "type": "string" }, "apiCategoryId": { "description": "The unique identifier for the category.", "type": "integer" }, "apiCategoryName": { "description": "The unique-per-account name of the category. Any empty value reflects back as an `__UNCATEGORIZED__` keyword.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the category.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the category.", "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the category.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the category.", "type": "string" }, "usageCount": { "description": "The number of endpoints that share the category.", "type": "integer" } }, "required": [ "apiCategoryName" ], "type": "object", "x-akamai": { "file-path": "schemas/category-dto.yaml" } } } }, "description": "New resource successfully created.", "headers": { "Location": { "description": "Relative URL for created API endpoint category.", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of the request input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } } }, "summary": "Create a category", "tags": [ "Categories" ] }, "get": { "description": "Lists all categories available to tag endpoints and optionally indicates the number of endpoints tagged under each category.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-categories" }, "operationId": "get-categories", "parameters": [ { "description": "Whether the response should include the `usageCount` data indicating the number of endpoints under a category, `false` by default.", "example": "{{withUsageInfo}}", "in": "query", "name": "withUsageInfo", "required": true, "schema": { "default": false, "example": false, "type": "boolean" }, "x-akamai": { "file-path": "parameters/with-usage-info-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "apiCategoryDescription": "The applications related to the IT department.", "apiCategoryId": 9903, "apiCategoryName": "IT", "createDate": "2019-06-17T12:42:42+0000", "createdBy": "bookstore_admin", "link": "/api-definitions/v1/api-categories/9903", "lockVersion": 0, "updateDate": "2019-06-17T12:42:42+0000", "updatedBy": "bookstore_admin" }, { "apiCategoryDescription": "The applications for internal use only.", "apiCategoryId": 9904, "apiCategoryName": "Internal", "createDate": "2019-06-17T12:43:11+0000", "createdBy": "bookstore_admin", "link": "/api-definitions/v1/api-categories/9904", "lockVersion": 0, "updateDate": "2019-06-17T12:43:11+0000", "updatedBy": "bookstore_admin" }, { "apiCategoryDescription": "The applications related to the Sales department.", "apiCategoryId": 9902, "apiCategoryName": "Sales", "createDate": "2019-06-17T12:40:14+0000", "createdBy": "bookstore_admin", "link": "/api-definitions/v1/api-categories/9902", "lockVersion": 0, "updateDate": "2019-06-17T12:40:14+0000", "updatedBy": "bookstore_admin" } ], "schema": { "description": "Endpoint categories.", "items": { "additionalProperties": false, "description": "An endpoint category.", "properties": { "apiCategoryDescription": { "description": "The description of the category that you may use to tag related endpoints. If you specify `null` or an empty string in the request, the JSON response doesn't include this field.", "nullable": true, "type": "string" }, "apiCategoryId": { "description": "The unique identifier for the category.", "type": "integer" }, "apiCategoryName": { "description": "The unique-per-account name of the category. Any empty value reflects back as an `__UNCATEGORIZED__` keyword.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the category.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the category.", "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the category.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the category.", "type": "string" }, "usageCount": { "description": "The number of endpoints that share the category.", "type": "integer" } }, "required": [ "apiCategoryName" ], "type": "object", "x-akamai": { "file-path": "schemas/category-dto.yaml" } }, "type": "array", "x-akamai": { "file-path": "schemas/category-dtos.yaml" } } } }, "description": "The response lists unique categories, or an empty list if there are none." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to get the API endpoint category list.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "List categories", "tags": [ "Categories" ] }, "x-akamai": { "file-path": "paths/categories.yaml", "path-info": "/categories" } }, "/categories/{apiCategoryId}": { "get": { "description": "Returns a specific category that you can use to tag endpoints.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-category" }, "operationId": "get-category", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "apiCategoryDescription": "The applications related to the Sales department.", "apiCategoryId": 9902, "apiCategoryName": "Sales", "createDate": "2019-06-17T12:40:14+0000", "link": "/api-definitions/v2/categories/9902", "lockVersion": 0, "updateDate": "2019-06-17T12:40:14+0000" }, "schema": { "additionalProperties": false, "description": "An endpoint category.", "properties": { "apiCategoryDescription": { "description": "The description of the category that you may use to tag related endpoints. If you specify `null` or an empty string in the request, the JSON response doesn't include this field.", "nullable": true, "type": "string" }, "apiCategoryId": { "description": "The unique identifier for the category.", "type": "integer" }, "apiCategoryName": { "description": "The unique-per-account name of the category. Any empty value reflects back as an `__UNCATEGORIZED__` keyword.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the category.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the category.", "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the category.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the category.", "type": "string" }, "usageCount": { "description": "The number of endpoints that share the category.", "type": "integer" } }, "required": [ "apiCategoryName" ], "type": "object", "x-akamai": { "file-path": "schemas/category-dto.yaml" } } } }, "description": "Response data shows the category." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to get the API endpoint category.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The API endpoint category doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } } }, "summary": "Get a category", "tags": [ "Categories" ] }, "put": { "description": "Updates a category's description or unique name.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/put-category" }, "operationId": "put-category", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "apiCategoryDescription": "The applications related to the Sales department.", "apiCategoryId": 9902, "apiCategoryName": "Sales", "createDate": "2019-06-17T12:40:14+0000", "link": "/api-definitions/v2/categories/9902", "lockVersion": 0, "updateDate": "2019-06-17T12:40:14+0000" }, "schema": { "additionalProperties": false, "description": "An endpoint category.", "properties": { "apiCategoryDescription": { "description": "The description of the category that you may use to tag related endpoints. If you specify `null` or an empty string in the request, the JSON response doesn't include this field.", "example": "{{apiCategoryDescription}}", "nullable": true, "type": "string" }, "apiCategoryId": { "description": "__Read-only__ The unique identifier for the category.", "example": "{{apiCategoryId}}", "readOnly": true, "type": "integer" }, "apiCategoryName": { "description": "The unique-per-account name of the category. Any empty value reflects back as an `__UNCATEGORIZED__` keyword.", "example": "{{apiCategoryName}}", "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the category.", "example": "{{createDate}}", "format": "date-time", "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the category.", "example": "{{createdBy}}", "readOnly": true, "type": "string" }, "link": { "description": "__Read-only__ The location of the navigable resource within this API, for use by API clients.", "example": "{{link}}", "readOnly": true, "type": "string" }, "lockVersion": { "description": "__Read-only__ The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "example": "{{lockVersion}}", "readOnly": true, "type": "integer" }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the category.", "example": "{{updateDate}}", "format": "date-time", "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the category.", "example": "{{updatedBy}}", "readOnly": true, "type": "string" }, "usageCount": { "description": "__Read-only__ The number of endpoints that share the category.", "example": "{{usageCount}}", "readOnly": true, "type": "integer" } }, "required": [ "apiCategoryName" ], "type": "object", "x-akamai": { "file-path": "schemas/category-dto-put.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "apiCategoryDescription": "The applications related to the Sales department.", "apiCategoryId": 9902, "apiCategoryName": "Sales", "createDate": "2019-06-17T12:40:14+0000", "link": "/api-definitions/v2/categories/9902", "lockVersion": 0, "updateDate": "2019-06-17T12:40:14+0000" }, "schema": { "additionalProperties": false, "description": "An endpoint category.", "properties": { "apiCategoryDescription": { "description": "The description of the category that you may use to tag related endpoints. If you specify `null` or an empty string in the request, the JSON response doesn't include this field.", "nullable": true, "type": "string" }, "apiCategoryId": { "description": "The unique identifier for the category.", "type": "integer" }, "apiCategoryName": { "description": "The unique-per-account name of the category. Any empty value reflects back as an `__UNCATEGORIZED__` keyword.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the category.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the category.", "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the category.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the category.", "type": "string" }, "usageCount": { "description": "The number of endpoints that share the category.", "type": "integer" } }, "required": [ "apiCategoryName" ], "type": "object", "x-akamai": { "file-path": "schemas/category-dto.yaml" } } } }, "description": "The response shows the updated category." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of the request input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to edit API endpoint category.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "Edit a category", "tags": [ "Categories" ] }, "delete": { "description": "Removes an unassigned category. If you assigned the category to at least one endpoint, the operation returns a 403 error.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/delete-category" }, "operationId": "delete-category", "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" } } ], "responses": { "204": { "content": {}, "description": "Category successfully deleted." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to edit the API endpoint category.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "Delete a category", "tags": [ "Categories" ] }, "parameters": [ { "description": "The unique identifier for the category.", "example": "{{apiCategoryId}}", "in": "path", "name": "apiCategoryId", "required": true, "schema": { "example": 17365, "type": "integer" }, "x-akamai": { "file-path": "parameters/api-category-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/api-category.yaml", "path-info": "/categories/{apiCategoryId}" } }, "/contracts/groups": { "get": { "description": "You provision each API endpoint within the context of your contract with Akamai and a Control Center portal group. The response objects encapsulate pairings of contract and group identifiers available within the scope of the user who provisioned the API token, as described in [Get started](https://techdocs.akamai.com/api-definitions/reference/api-get-started).", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-contracts-groups" }, "operationId": "get-contracts-groups", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "acgId": "3-1Cgoa", "contractId": "C-0N7RAC71", "displayName": "Bookstore Users", "groupId": 54321 }, { "acgId": "3-1Cgoa.G75683", "contractId": "K-0N7RAK7", "displayName": "Bookstore Users - Developers", "groupId": 12345 } ], "schema": { "description": "Pairings of contracts and groups under which you provision the security and delivery settings for an endpoint.", "items": { "additionalProperties": false, "description": "A pairing of contract and group under which you provision the security and delivery settings for an endpoint.", "properties": { "acgId": { "description": "The unique identifier for the pairing of contract and group.", "type": "string" }, "contractId": { "description": "The unique identifier for the Akamai contract within the pairing.", "type": "string" }, "displayName": { "description": "The descriptive name for the pairing of contract and group.", "type": "string" }, "groupId": { "description": "The unique identifier for the group within the pairing.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/a-cg-picker-row.yaml" } }, "type": "array", "x-akamai": { "file-path": "schemas/a-cg-picker-rows.yaml" } } } }, "description": "The response lists combined contracts and groups you can use for API definitions." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to edit the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "List contracts and groups", "tags": [ "Contracts and groups" ] }, "x-akamai": { "file-path": "paths/groups.yaml", "path-info": "/contracts/groups" } }, "/contracts/{contractId}/groups/{groupId}/hosts": { "get": { "description": "Lists all hostnames through which API consumers can access an endpoint service under a given contract and group pairing. You can use Property Manager (or [PAPI](https://techdocs.akamai.com/property-mgr/reference/api)) to create new hostnames to make available to users.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-contract-group-hosts" }, "operationId": "get-contract-group-hosts", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": [ "bookstore.api.akamai.com", "bookstore2.api.akamai.com" ], "schema": { "description": "Hostnames assigned to an endpoint.", "items": { "type": "string" }, "type": "array", "x-akamai": { "file-path": "schemas/hosts-schema.yaml" } } } }, "description": "The response lists hosts for the contract and group." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to read the API endpoint for the specified contract and group.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "List hostnames", "tags": [ "Contracts and groups" ] }, "parameters": [ { "description": "The unique identifier for the group.", "example": "{{groupId}}", "in": "path", "name": "groupId", "required": true, "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/group-id-path.yaml" } }, { "description": "The unique identifier for the contract.", "example": "{{contractId}}", "in": "path", "name": "contractId", "required": true, "schema": { "example": "K-0N7RAK7", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/hosts.yaml", "path-info": "/contracts/{contractId}/groups/{groupId}/hosts" } }, "/contracts/{contractId}/groups/{groupId}/hostsAcgs": { "get": { "description": "Lists all hostnames through which API consumers can access an endpoint service under a given contract and group pairing. Returns each hostname together with the access control group where the hostname is registered. You can use Property Manager (or [PAPI](https://techdocs.akamai.com/property-mgr/reference/api)) to create new hostnames to make available to users.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-contract-group-hosts-acgs" }, "operationId": "get-contract-group-hosts-acgs", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "acgId": "WAA-3-1AINU1T", "contractId": "C-0N7RAC7", "hostname": "www.bookstore.api.akamai.com" }, { "acgId": "WAA-3-WNNG6F", "contractId": "C-0N7RAC7", "hostname": "www.bookstore2.api.akamai.com" } ], "schema": { "description": "Hostnames assigned to an endpoint.", "items": { "additionalProperties": false, "description": "A hostname and access control group where the hostname is registered.", "properties": { "acgId": { "description": "The unique identifier for the access control group where the hostname is registered.", "type": "string" }, "contractId": { "description": "The unique identifier for the Akamai contract within the access control group.", "type": "string" }, "hostname": { "description": "The hostname that may receive traffic for an endpoint.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/acgs-host.yaml" } }, "type": "array", "x-akamai": { "file-path": "schemas/acgs-hosts.yaml" } } } }, "description": "Response data lists hosts for the contract and group." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to read the API endpoint for the specified contract and group.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "List hostnames with access control groups", "tags": [ "Contracts and groups" ] }, "parameters": [ { "description": "The unique identifier for the group.", "example": "{{groupId}}", "in": "path", "name": "groupId", "required": true, "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/group-id-path.yaml" } }, { "description": "The unique identifier for the contract.", "example": "{{contractId}}", "in": "path", "name": "contractId", "required": true, "schema": { "example": "K-0N7RAK7", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/hosts-acgs.yaml", "path-info": "/contracts/{contractId}/groups/{groupId}/hostsAcgs" } }, "/endpoints": { "post": { "description": "Creates the first version of an API endpoint configuration. You can specify the new endpoint's full set of resources. Alternatively, you can create them later either by modifying the endpoint object, or separately with the [Create a resource](https://techdocs.akamai.com/api-definitions/reference/post-resource) operation. The endpoint's name needs to be unique within an account.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/post-endpoints" }, "operationId": "post-endpoints", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "akamaiSecurityRestrictions": { "MAX_BODY_SIZE": 61056, "MAX_DOC_DEPTH": 64, "MAX_ELEMENT_NAME_LENGTH": 256, "MAX_INTEGER_VALUE": 9999, "MAX_JSONXML_ELEMENT": 1032, "MAX_STRING_LENGTH": 8192, "POSITIVE_SECURITY_ENABLED": 1 }, "apiCategoryIds": [ 2, 7 ], "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointName": "Bookstore API", "apiEndPointScheme": "http/https", "apiGatewayEnabled": true, "apiResources": [ { "apiResourceMethods": [ { "apiParameters": [ { "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "array": false, "response": false } ], "apiResourceMethod": "GET" }, { "apiParameters": [ { "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": { "lengthRestriction": { "lengthMax": 15, "lengthMin": 3 } }, "apiParameterType": "string", "array": false, "response": false } ], "apiResourceMethod": "POST" } ], "apiResourceName": "books", "description": "A book item within the bookstore API.", "resourcePath": "/books/{bookId}" } ], "basePath": "/bookstore", "consumeType": "any", "contractId": "C-0N7RAC7", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "groupId": 12345, "isGraphQL": false, "lockVersion": 0, "securityScheme": { "securitySchemeDetail": { "apiKeyLocation": "header", "apiKeyName": "apikey" }, "securitySchemeType": "apikey" } }, "schema": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in cookies. These booleans override fields in the Method object. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the field is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__Read-only__ Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__Read-only__ The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__Read-only__ Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__Read-only__ The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__Read-only__ Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `json/xml`, or `urlencoded`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "json/xml", "urlencoded" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-request.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-request.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-request.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An endpoint and its associated resources.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-request.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "akamaiSecurityRestrictions": null, "apiCategoryIds": [ 2, 7 ], "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": 492375, "apiEndPointLocked": false, "apiEndPointName": "Bookstore API", "apiEndPointScheme": "http/https", "apiEndPointVersion": 574127, "apiGatewayEnabled": true, "apiResources": [ { "apiResourceClonedFromId": null, "apiResourceId": 2926712, "apiResourceLogicId": 118435, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578116, "apiParameterId": 1212945, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 494448, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "GET", "apiResourceMethodId": 341591, "apiResourceMethodLogicId": 184404 }, { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578117, "apiParameterId": 1212946, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": { "arrayRestriction": { "maxItems": 200, "minItems": 100 }, "numberRangeRestriction": null, "rangeRestriction": null, "responseRestriction": { "maxBodySize": "SIZE_6K", "statusCodes": [ 200, 201 ] }, "xmlConversionRule": null }, "apiParameterType": "string", "apiResourceMethParamId": 494449, "array": false, "pathParamLocationId": null } ], "apiResourceMethod": "POST", "apiResourceMethodId": 341592, "apiResourceMethodLogicId": 184405 } ], "apiResourceName": "books", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "A book item within the bookstore API.", "link": null, "lockVersion": 0, "private": false, "resourcePath": "/books/{bookId}", "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin" } ], "availableActions": [ "DELETE", "CLONE_ENDPOINT", "ACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING" ], "basePath": "/bookstore", "caseSensitive": true, "clonedFromVersion": null, "consumeType": "any", "contractId": "C-0N7RAC71", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "discoveredPiiIds": [ 455976 ], "endpointHidden": false, "groupId": 12345, "isGraphQL": false, "lockVersion": 0, "positiveConstrainsEnabled": null, "productionStatus": null, "productionVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "protectedByApiKey": true, "responseConstraintsEnabled": false, "securityScheme": { "securitySchemeDetail": { "apiKeyLocation": "header", "apiKeyName": "apikey" }, "securitySchemeType": "apikey" }, "source": null, "stagingStatus": null, "stagingVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin", "versionHidden": false, "versionNumber": 1 }, "schema": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in cookies. These booleans override fields in the Method object. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the field is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__Read-only__ Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__Read-only__ The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__Read-only__ Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__Read-only__ The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__Read-only__ Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An endpoint and its associated resources.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-response.yaml" } } } }, "description": "New resource successfully created.", "headers": { "Location": { "description": "Relative URL for the created API endpoint.", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Invalid data input.", "x-akamai": { "file-path": "errors/400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have access to the contract and group.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "Register an endpoint", "tags": [ "Endpoints" ] }, "get": { "description": "Lists the available API endpoints, with results optionally paginated, sorted, and filtered. If no endpoints are available, the operation responds with an empty array.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-endpoints" }, "operationId": "get-endpoints", "parameters": [ { "description": "Return only endpoints with personally identifiable information (PII), `false` by default.", "example": "{{piiOnly}}", "in": "query", "name": "piiOnly", "required": false, "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/pii-query.yaml" } }, { "description": "The page number index, starting at the default value of `1`.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "default": 1, "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-query.yaml" } }, { "description": "The number of endpoints on each page of results, `25` by default.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-size-query.yaml" } }, { "description": "Filters endpoints by the specified `apiCategoryName`, including the `__UNCATEGORIZED__` keyword.", "example": "{{category}}", "in": "query", "name": "category", "schema": { "example": "Sales", "type": "string" }, "x-akamai": { "file-path": "parameters/category-query.yaml" } }, { "description": "The search query substring criteria matching the endpoint's name, description, `basePath`, `apiCategoryName`, and `resourcePath`.", "example": "{{contains}}", "in": "query", "name": "contains", "schema": { "example": "Sales", "type": "string" }, "x-akamai": { "file-path": "parameters/contains-query.yaml" } }, { "description": "__Enum__ The field to sort endpoints by, either the `updateDate` or the API `name` that corresponds to the `apiEndPointName` in data. The default is `name`.", "example": "{{sortBy}}", "in": "query", "name": "sortBy", "schema": { "default": "name", "enum": [ "name", "updateDate" ], "example": "name", "type": "string" }, "x-akamai": { "file-path": "parameters/sort-by-query.yaml" } }, { "description": "__Enum__ The sort order, either `desc` for descending or the default `asc` for ascending.", "example": "{{sortOrder}}", "in": "query", "name": "sortOrder", "schema": { "default": "asc", "enum": [ "asc", "desc" ], "example": "desc", "type": "string" }, "x-akamai": { "file-path": "parameters/sort-order-query.yaml" } }, { "description": "__Enum__ The preference for selecting the endpoint version to return. By default the API returns the `LAST_UPDATED` version. If you set the preference to `ACTIVATED_FIRST`, the API first attempts to return the version currently active on the production network. If such version doesn't exist, the API attempts to return the version currently active on the staging network. If both of these checks fail, the API returns the last updated version.", "example": "{{versionPreference}}", "in": "query", "name": "versionPreference", "schema": { "default": "LAST_UPDATED", "enum": [ "ACTIVATED_FIRST", "LAST_UPDATED" ], "example": "ACTIVATED_FIRST", "type": "string" }, "x-akamai": { "file-path": "parameters/version-preference-query.yaml" } }, { "description": "__Enum__ The type of endpoints to return based on their visibility status. By default the API returns `ALL` endpoints. You can instead decide to return `ONLY_VISIBLE` endpoints, or `ONLY_HIDDEN` endpoints. Run the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) and [Hide an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-hide) operations to control which endpoints are listed.", "example": "{{show}}", "in": "query", "name": "show", "schema": { "default": "ALL", "enum": [ "ALL", "ONLY_VISIBLE", "ONLY_HIDDEN" ], "example": "ONLY_VISIBLE", "type": "string" }, "x-akamai": { "file-path": "parameters/show-query.yaml" } }, { "description": "Filters endpoints to a specific contract. You need to specify this along with a `groupId`.", "example": "{{contractId}}", "in": "query", "name": "contractId", "schema": { "example": "K-0N7RAK7", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-query.yaml" } }, { "description": "Filters endpoints to a specific group. You need to specify this along with a `contractId`.", "example": "{{groupId}}", "in": "query", "name": "groupId", "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/group-id-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "apiEndPoints": [ { "apiCategoryIds": [], "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": 574127, "apiEndPointLocked": false, "apiEndPointName": "Bookstore API Premium", "apiEndPointScheme": "http/https", "apiResourceBaseInfo": [ { "apiResourceClonedFromId": null, "apiResourceId": 2926712, "apiResourceLogicId": 118435, "apiResourceName": "/books/{bookId}", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "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" } ], "availableActions": [ "CLONE_ENDPOINT", "SHOW_ENDPOINT", "COMPARE_ENDPOINT", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION" ], "basePath": "/bookstore-premium", "clonedFromVersion": 1, "consumeType": "any", "contractId": "C-0N7RAC7", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "endpointHidden": true, "groupId": 12345, "pii": { "types": [ "PERSONAL_EMAIL" ] }, "positiveConstrainsEnabled": true, "productionVersion": { "status": null, "versionNumber": null }, "responseConstraintsEnabled": true, "stagingVersion": { "status": null, "versionNumber": null }, "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin", "versionHidden": true, "versionNumber": 2 } ], "page": 8, "pageSize": 1, "totalSize": 15 }, "schema": { "additionalProperties": false, "description": "A collection of requested endpoints.", "properties": { "apiEndPoints": { "description": "The returned endpoint objects.", "items": { "additionalProperties": false, "properties": { "apiCategoryIds": { "description": "The category identifiers that apply to this endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname to activate the endpoint.", "items": { "type": "string" }, "type": "array" }, "apiEndPointId": { "description": "The unique identifier for the endpoint.", "type": "integer" }, "apiEndPointLocked": { "description": "Whether the endpoint version is read-only.", "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "type": "string" }, "apiEndPointVersion": { "description": "The unique identifier for the endpoint version.", "type": "integer" }, "apiResourceBaseInfo": { "description": "Resource objects assigned to the endpoint.", "items": { "additionalProperties": false, "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 different endpoint versions.", "type": "integer" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify an empty string in the request or omit this field from the object, the JSON response reflects it as `null`.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier 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" }, "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.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "type": "object" }, "type": "array" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "Available [actions](https://techdocs.akamai.com/api-definitions/docs/api-config-version-mgmt#actions) that you can perform on the endpoint depending on its versions' activation status.", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "type": "array", "x-akamai": { "enum-descriptions": { "ACTIVATE_ON_PRODUCTION": "Activate on production. Available when version is inactive or deactivated.", "ACTIVATE_ON_STAGING": "Activate on staging. Available when version is inactive or deactivated.", "CLONE_ENDPOINT": "Clone the endpoint from another existing endpoint.", "CLONE_VERSION": "Clone a new version from another existing version.", "COMPARE_AAG_SETTINGS": "Compare AAG settings between different versions.", "COMPARE_ENDPOINT": "Compare the endpoint between different versions.", "COMPARE_RAPID_SETTINGS": "Compare RAPID settings between different versions.", "COMPARE_RESOURCE_PURPOSES": "Compare resource purposes between different versions.", "DEACTIVATE_ON_PRODUCTION": "Deactivate on production. Available when version is active.", "DEACTIVATE_ON_STAGING": "Deactivate on staging. Available when version is active.", "DELETE": "Delete the version. Only available for inactive versions.", "EDIT_AAG_SETTINGS": "Edit AAG settings.", "EDIT_ENDPOINT_DEFINITION": "Edit the endpoint definition.", "HIDE_VERSION": "Hide the version so that it no longer appears in the version history. You can't activate or delete hidden versions.", "RESOURCES": "View resources.", "SHOW_VERSION": "Reveal the version so that it becomes visible in the version history.", "VIEW_AAG_SETTINGS": "View AAG settings." } } }, "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 field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "type": "boolean" }, "clonedFromVersion": { "description": "For cloned endpoints, the unique identifier for the source endpoint version.", "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `json/xml` for dual-format APIs, `any`, or `none`.", "enum": [ "json", "xml", "json/xml", "any", "none" ], "type": "string" }, "contractId": { "description": "The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "endpointHidden": { "description": "Indicates whether the endpoint is hidden. You can't 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.", "type": "boolean" }, "groupId": { "description": "The unique identifier for the group in the Control Center portal under which you activated security and delivery settings for this API.", "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.", "type": "integer" }, "pii": { "additionalProperties": false, "description": "Personally identifiable information. See [API concepts](https://techdocs.akamai.com/api-definitions/reference/api-concepts) for more information.", "properties": { "types": { "description": "The PII type. Either `PERSONAL_EMAIL` or `CREDIT_OR_DEBIT_CARD_NUMBER`.", "items": { "enum": [ "PERSONAL_EMAIL", "CREDIT_OR_DEBIT_CARD_NUMBER" ], "type": "string" }, "type": "array" } }, "type": "object" }, "positiveConstrainsEnabled": { "description": "Enables App & API Protector firewall policies for the endpoint.", "type": "boolean" }, "productionVersion": { "description": "An endpoint version's activation status on the production network.", "type": "object" }, "responseConstraintsEnabled": { "description": "Enables App & API Protector firewall policies for the responses.", "type": "boolean" }, "source": { "description": "The import file used to create the endpoint.", "nullable": true, "type": "object" }, "stagingVersion": { "description": "An endpoint version's activation status on the staging network.", "type": "object" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" }, "versionHidden": { "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" }, "versionNumber": { "description": "The endpoint version number.", "type": "integer" } }, "required": [ "apiEndPointName" ], "type": "object" }, "type": "array" }, "page": { "description": "The number of the current page with results.", "minimum": 1, "type": "integer" }, "pageSize": { "description": "The number of endpoints on each page with results.", "type": "integer" }, "totalSize": { "description": "The total number of endpoints available in the returned set.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-list-dto.yaml" } } } }, "description": "Lists API Endpoints you can access." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to get the API endpoint list.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "List endpoints", "tags": [ "Endpoints" ] }, "x-akamai": { "file-path": "paths/endpoints.yaml", "path-info": "/endpoints" } }, "/endpoints/cloneEndpoint": { "post": { "description": "Creates an endpoint as a clone from the specified source endpoint ID and version.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/post-endpoint-clone" }, "operationId": "post-endpoint-clone", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": 492375, "apiEndPointName": "Bookstore API Premium", "basePath": "/bookstore-premium", "contractId": "C-0N7RAC71", "groupId": 32145, "versionNumber": 1 }, "schema": { "additionalProperties": false, "description": "An endpoint to clone.", "properties": { "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "type": "array" }, "apiEndPointId": { "description": "The unique identifier for the endpoint. For the clone operation, this is the ID of the source endpoint.", "example": "{{apiEndPointId}}", "type": "integer" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "example": "{{apiEndPointName}}", "type": "string" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values for the endpoint. This is `/` if empty. Don't append a `/` character to the path.", "example": "{{basePath}}", "minLength": 0, "type": "string" }, "contractId": { "description": "The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "example": "{{contractId}}", "type": "string" }, "groupId": { "description": "The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "example": "{{groupId}}", "type": "integer" }, "versionNumber": { "description": "The endpoint version number. For the clone operation, this is the source endpoint version number.", "example": "{{versionNumber}}", "type": "integer" } }, "required": [ "contractId", "groupId", "apiEndPointName", "basePath", "apiEndPointHosts" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-clone-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "akamaiSecurityRestrictions": null, "apiCategoryIds": [ 2, 7 ], "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": 492375, "apiEndPointLocked": false, "apiEndPointName": "Bookstore API Premium", "apiEndPointScheme": "http/https", "apiEndPointVersion": 574127, "apiResources": [ { "apiResourceClonedFromId": null, "apiResourceId": 2926712, "apiResourceLogicId": 118435, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578116, "apiParameterId": 1212945, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 494448, "array": false, "pathParamLocationId": null } ], "apiResourceMethod": "GET", "apiResourceMethodId": 341591, "apiResourceMethodLogicId": 184404 }, { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578117, "apiParameterContentType": "json", "apiParameterId": 1212946, "apiParameterLocation": "body", "apiParameterName": "books", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": { "arrayRestriction": null, "lengthRestriction": { "lengthMax": 15, "lengthMin": 3 }, "numberRangeRestriction": null, "rangeRestriction": null, "xmlConversionRule": null }, "apiParameterType": "string", "apiResourceMethParamId": 494449, "array": true, "pathParamLocationId": null } ], "apiResourceMethod": "POST", "apiResourceMethodId": 341592, "apiResourceMethodLogicId": 184405 } ], "apiResourceName": "books", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "A book item within the bookstore API.", "link": null, "lockVersion": 2, "private": false, "resourcePath": "/books/{bookId}", "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin" } ], "availableActions": [ "DELETE", "CLONE_ENDPOINT", "ACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING" ], "basePath": "/bookstore-premium", "caseSensitive": true, "clonedFromVersion": 1, "consumeType": "any", "contractId": "C-0N7RAC71", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "endpointHidden": false, "groupId": 12345, "isGraphQL": false, "lockVersion": 2, "positiveConstrainsEnabled": null, "productionStatus": null, "productionVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "protectedByApiKey": true, "securityScheme": { "securitySchemeDetail": { "apiKeyLocation": "header", "apiKeyName": "apikey" }, "securitySchemeType": "apikey" }, "source": null, "stagingStatus": null, "stagingVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin", "versionHidden": false, "versionNumber": 2 }, "schema": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in cookies. These booleans override fields in the Method object. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the field is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__Read-only__ Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__Read-only__ The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__Read-only__ Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__Read-only__ The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__Read-only__ Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An endpoint and its associated resources.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-response.yaml" } } } }, "description": "Created API Endpoint.", "headers": { "Location": { "description": "Relative URL for the cloned API endpoint.", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of user input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have access to the endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } } }, "summary": "Clone an endpoint", "tags": [ "Endpoints" ] }, "x-akamai": { "file-path": "paths/clone-endpoint.yaml", "path-info": "/endpoints/cloneEndpoint" } }, "/endpoints/files": { "post": { "description": "Imports an API definition file and creates a new endpoint based on the file contents, optionally stripping out request or response body specifications. You can run this operation in two ways. To POST JSON data, see [Make a JSON request to register an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/endpoint-request-json). To make a form request using these parameters, see [Make a form request to register an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/endpoint-request-form).", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/post-endpoints-file" }, "operationId": "post-endpoints-file", "parameters": [ { "description": "Excludes any request body specifications from what's imported, `false` by default.", "example": "{{excludeRequestContent}}", "in": "query", "name": "excludeRequestContent", "required": false, "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/exclude-request-content-query.yaml" } }, { "description": "Excludes any response body specifications from what's imported, `false` by default.", "example": "{{excludeResponseContent}}", "in": "query", "name": "excludeResponseContent", "required": false, "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/exclude-response-content-query.yaml" } }, { "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" } } ], "requestBody": { "content": { "application/json": { "example": { "contractId": "K-0N7RAK71", "groupId": 32145, "importFileContent": "ewogICJzd2FnZ2Vy ... ICAgfQogIH0KfQ==", "importFileFormat": "swagger", "importFileSource": "BODY_BASE64" }, "schema": { "additionalProperties": false, "description": "An API definition file to import.", "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": "integer" }, "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 can import RAML 0.8 files and Swagger 2.0 or 3.0 files.", "enum": [ "raml", "swagger" ], "example": "{{importFileFormat}}", "type": "string" }, "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.", "enum": [ "URL", "BODY_BASE64" ], "example": "{{importFileSource}}", "type": "string" }, "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" } }, "required": [ "importFileFormat", "importFileSource" ], "type": "object", "x-akamai": { "file-path": "schemas/import-file-dto.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "akamaiSecurityRestrictions": null, "apiCategoryIds": [ 2, 7 ], "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": 492375, "apiEndPointLocked": false, "apiEndPointName": "Bookstore API", "apiEndPointScheme": "http/https", "apiGatewayEnabled": true, "apiResources": [ { "apiResourceClonedFromId": null, "apiResourceId": 2926712, "apiResourceLogicId": 118435, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578116, "apiParameterId": 1212945, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 494448, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "GET", "apiResourceMethodId": 341591, "apiResourceMethodLogicId": 184404 }, { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578117, "apiParameterId": 1212946, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": { "arrayRestriction": null, "lengthRestriction": { "lengthMax": 15, "lengthMin": 3 }, "numberRangeRestriction": null, "rangeRestriction": null, "xmlConversionRule": null }, "apiParameterType": "string", "apiResourceMethParamId": 494449, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 341592, "apiResourceMethodLogicId": 184405 } ], "apiResourceName": "books", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "A book item within the bookstore API.", "link": null, "lockVersion": 2, "private": false, "resourcePath": "/books/{bookId}", "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin" } ], "availableActions": [ "DELETE", "CLONE_ENDPOINT", "ACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING" ], "basePath": "/bookstore", "caseSensitive": true, "clonedFromVersion": 1, "consumeType": "any", "contractId": "C-0N7RAC71", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "endpointHidden": false, "groupId": 12345, "isGraphQL": false, "lockVersion": 2, "positiveConstrainsEnabled": null, "productionStatus": null, "productionVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "protectedByApiKey": true, "responseConstraintsEnabled": false, "securityScheme": { "securitySchemeDetail": { "apiKeyLocation": "header", "apiKeyName": "apikey" }, "securitySchemeType": "apikey" }, "source": null, "stagingStatus": null, "stagingVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin", "versionHidden": false, "versionNumber": 1 }, "schema": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in cookies. These booleans override fields in the Method object. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the field is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__Read-only__ Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__Read-only__ The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__Read-only__ Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__Read-only__ The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__Read-only__ Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An endpoint and its associated resources.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-response.yaml" } } } }, "description": "New resource successfully created.", "headers": { "Location": { "description": "Relative URL for the newly created API endpoint.", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "example": { "apiEndpointDetails": { "akamaiSecurityRestrictions": null, "apiCategoryIds": null, "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": null, "apiEndPointLocked": null, "apiEndPointName": "Bookstore API", "apiEndPointScheme": "http/https", "apiResources": [], "basePath": "/bookstore", "clonedFromVersion": null, "consumeType": "any", "contractId": "K-0N7RAK7", "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 }, "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": "A result of an import operation, including endpoint details and a list of potential issues.", "properties": { "apiEndpointDetails": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in cookies. These booleans override fields in the Method object. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the field is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__Read-only__ Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__Read-only__ The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__Read-only__ Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__Read-only__ The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__Read-only__ Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "The imported endpoint.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-response.yaml" } }, "problems": { "description": "Problems that occurred during the import, such as schema errors or unsupported property warnings.", "items": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/import-result.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of the file input data is invalid.", "x-akamai": { "file-path": "errors/400-import.yaml" } } }, "summary": "Register an endpoint from an API definition file", "tags": [ "Endpoints" ] }, "x-akamai": { "file-path": "paths/files.yaml", "path-info": "/endpoints/files" } }, "/endpoints/user-entitlements": { "get": { "description": "Lists user entitlements based on your assigned permissions. It helps you determine if your user identity assigned to the API client can run various other operations to modify data. See [Get started](https://techdocs.akamai.com/api-definitions/reference/api-get-started) for details on setting up the API client with the appropriate level of access. This operation's array values include `API_READ` for read-only access, `API_WRITE` for modifying the existing endpoint versions, `API_VERSIONING` for version management, `API_FEATURES` for access to App & API Protector security features, `AAG_FEATURES` for access to delivery features, and `API_PURPOSE` for access to resource purpose settings. Note that the `API_FEATURES` permission is only available for App & API Protector customers, and the `API_PURPOSE` permission is for Bot Manager customers.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-user-entitlements" }, "operationId": "get-user-entitlements", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": [ "API_READ", "API_WRITE", "API_VERSIONING", "API_FEATURES" ], "schema": { "description": "User entitlements based on the assigned permissions, either `API_READ` for read-only access, `API_WRITE` for edit access, `API_VERSIONING` for access to version management, `API_FEATURES` for access to App & API Protector features, `AAG_FEATURES` for access to delivery settings, or `API_PURPOSE` for access to resource purpose settings.", "items": { "enum": [ "API_READ", "API_WRITE", "API_VERSIONING", "API_FEATURES", "AAG_FEATURES", "API_PURPOSE" ], "type": "string" }, "type": "array", "x-akamai": { "file-path": "schemas/user-entitlements-dto.yaml" } } } }, "description": "Set of entitlements." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have access to the endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "List user entitlements", "tags": [ "Endpoints" ] }, "x-akamai": { "file-path": "paths/user-entitlements.yaml", "path-info": "/endpoints/user-entitlements" } }, "/endpoints/verify-secure-connection": { "post": { "description": "Verifies that provided hostnames are signed with a provided certificate chain. This ensures that edge servers can connect to the hostnames securely. The response is a map of hostnames to connection status values. For the list of available connection status values and their descriptions, see Connection status values. You can use the response information when setting up JWKS in the [Edit JWT settings](https://techdocs.akamai.com/api-definitions/reference/put-jwt-settings) operation.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/post-endpoints-verify-secure-connection" }, "operationId": "post-endpoints-verify-secure-connection", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "certChain": { "content": "-----BEGIN CERTIFICATE-----\nMIIFsDCCA5igAwIBAgIJAL7HIonYis0aMA0GCSqGSIb3DQEBCwUAMG0xCzAJBgNV\nBAYTAlVTMREwDwYDVQQIDAhyYXBpZHppazERMA8GA1UEBwwIcmFwaWR6aWsxETAP\nBgNVBAoMCHJhcGlkemlrMREwDwYDVQQLDAhyYXBpZHppazESMBAGA1UEAwwJbG9j\nYWxob3N0MB4XDTE5MDYxMTE0MzI0NloXDTI0MDYwOTE0MzI0NlowbTELMAkGA1UE\nBhMCVVMxETAPBgNVBAgMCHJhcGlkemlrMREwDwYDVQQHDAhyYXBpZHppazERMA8G\nA1UECgwIcmFwaWR6aWsxETAPBgNVBAsMCHJhcGlkemlrMRIwEAYDVQQDDAlsb2Nh\nbGhvc3QwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCua7kn9yrkpMMH\nT18yzPFK9LBPk4GzMX0BZfEi2jzKKoc00BtoU/zeS9ewj+2IdIoHa19GE7qnnMux\nkbwm6GNkFt4rzJsQ5ruMSKEqzd4I81HDmS5s2X3o4ZqYWVHAx/rqsh5EIt5qAjq4\njebXeMuhlnkx6jMs+4+ZFfATVvOJ78VnUGUheNTcTGgCvxU7ZZ3+IZubJ6BVdJjC\nwxM30eroVF3efX4HrRXhLtatQtxjX6g2qOUfFiuNNLcgx+4NPqbKpecqyUbopt18\n72MmohKy+YfVEk7OFWLyNPoL237KCznkCGwcQYrXTJzDVAN4NqQEo513nIHEC89F\nX/WomZWwLKVyQpiA1z/jUdYnSzsrPSuA+oP1WmfwVjtxeiwB7Asy/d/5OmOtID+a\nzT41irl1Dp5F6mgAI8CZ1LnzYIlvJAQS9+cpLG9rsyYDRr5+78TebiqP02CrRj9S\nstoam6WG21Z9fJ/aPKJ0ZQHkpXuHDy6RHJro+2wk0coWOyNT0UH6/7kuKHjEGaAG\nBXjElxZ8pJySwYXeeD5gmimQKPE/us1BD2jk0KWYxnwJ+jM4S7RipgTSGsy3Nw42\nvKnKw6FwOIoQqwTkiNF+p7EsjeciO09zLecXxlh3p8WREEZU5NICmGL7xItdD+7I\nVr/tn3XNbuSUu0IqdbhO19JoNXG/UwIDAQABo1MwUTAdBgNVHQ4EFgQUcXwqRZUC\nj9+VsyCfy4oIMN9u1V0wHwYDVR0jBBgwFoAUcXwqRZUCj9+VsyCfy4oIMN9u1V0w\nDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAgEAQgWlrEW+K3fCMO9K\n2TuxY6ruXbdekRv+nw+weXe9+GLlyvEFxktYTE/cN8pHrKOG6F/ea+CCHW4xenVp\npchFI8zPQ8kDEDUUrPaQLbw9kzXKLZwUs+KMZXEZJInxWrr1mWeP+lVSf6f4hwNd\nfvJ8SOPe3/IAE0C79JaclzYE3ErfTlBeouQ09jXbeHc0VvodFp7XcmIMA9e5zIzu\nCU1QOa1LRrn5+TI41BbjKypMl8EE7ZEoyWRj4sMQGfuh9/kmu9ZPINJ79/j22vZG\nVj72jKoIu01qI0esfL7GcE9gd9eWhDRuBYNCAfXWK7xvMwYIxeLgP9LJoeBCVMV+\n7k1AHGpgU4UYveu71VCUIlGIaL1t/DKHi8SqDaKV2eImurPp90eLWAU1V6b+UG5/\n+HoUI8Kd5KgfPprv4AKKOTse04xbFDehvgCpQpcwzoV0h2AQtHhsN65dXfO3XPnR\nYQka7OQcEJS/gLXl7FIcpfkNyvi8ompHVSGTnAEB4qAwazz3FWe6r7qbqty2n0Ye\nNTkylMbBMFpMZrP4BP6YFf3BnkzjFcffHvtVGGUbyebQazc+5HyZycabEhekETeS\nLUOCwFWH68wXI23eU5Z7mKAI+rwhqVuJZPzZFUWfNhj7Pt/aby+7SIZAQ9YCR2lk\n6IUdRIpisR9k478g/4pQYly6yN4=\n-----END CERTIFICATE-----", "name": "bookstore_cert.pem" }, "hosts": [ "bookstore.api.akamai.com", "bookstore2.api.akamai.com:8443", "bookstore-premium.api.akamai.com" ] }, "schema": { "additionalProperties": false, "description": "Contains the hostnames and certificate chain for secure connection verification.", "properties": { "certChain": { "additionalProperties": false, "description": "A PEM file with the certificate to use for verification of hostnames included in the corresponding `hosts` field.", "properties": { "content": { "description": "The contents of the PEM file that includes the certificate.", "type": "string" }, "name": { "description": "The name of the PEM file that includes the certificate.", "type": "string" } }, "type": "object" }, "hosts": { "description": "HTTPS hostnames to verify. Each hostname needs to be digitally signed with the certificate chain described in the corresponding `certChain` field. If your hostname uses a different port for secure connections than the default 443, you can indicate it after a colon.", "items": { "type": "string" }, "type": "array" } }, "required": [ "hosts", "certChain" ], "type": "object", "x-akamai": { "file-path": "schemas/verify-secure-connection-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "bookstore-premium.api.akamai.com": { "detail": "The common name in the hostname certificate doesn't correspond to the common name in the hostname. Ensure that both entities refer to the same common name.", "title": "CN_MISMATCH_ERROR" }, "bookstore.api.akamai.com": { "detail": "The hostname is signed with the provided certificate chain and API Gateway can establish a secure connection.", "title": "OK" } }, "schema": { "description": "Each hostname to verify and its corresponding connection status.", "type": "object", "x-akamai": { "file-path": "schemas/verify-secure-connection-dto-response.yaml" } } } }, "description": "The map of hostnames to verification statuses." } }, "summary": "Verify secure connection", "tags": [ "Endpoints" ] }, "x-akamai": { "file-path": "paths/verify-secure-connection.yaml", "path-info": "/endpoints/verify-secure-connection" } }, "/endpoints/{apiEndPointId}": { "delete": { "description": "Removes an endpoint configuration from API Gateway if none of the endpoint's versions are active or pending activation on the staging or production network.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/delete-endpoint" }, "operationId": "delete-endpoint", "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" } } ], "responses": { "204": { "content": {}, "description": "Resource successfully deleted." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have access to the endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } } }, "summary": "Delete an endpoint", "tags": [ "Endpoints" ] }, "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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/api-endpoint.yaml", "path-info": "/endpoints/{apiEndPointId}" } }, "/endpoints/{apiEndPointId}/hide": { "post": { "description": "Hides an endpoint and all its versions. You can only hide an endpoint with no active versions on the staging or production network. You can't activate or delete versions of a hidden endpoint. A hidden endpoint appears in the [List endpoints](https://techdocs.akamai.com/api-definitions/reference/get-endpoints) operation's response object by default, or when you set the operation's `show` query parameter to `ONLY_HIDDEN`. Running this operation affects the endpoint listing in the API Definitions user interface.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/post-endpoint-hide" }, "operationId": "post-endpoint-hide", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "akamaiSecurityRestrictions": null, "apiCategoryIds": [ 2, 7 ], "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": 492375, "apiEndPointLocked": false, "apiEndPointName": "Bookstore API", "apiEndPointScheme": "http/https", "apiGatewayEnabled": true, "apiResources": [ { "apiResourceClonedFromId": null, "apiResourceId": 2926712, "apiResourceLogicId": 118435, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578116, "apiParameterId": 1212945, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 494448, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "GET", "apiResourceMethodId": 341591, "apiResourceMethodLogicId": 184404 }, { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578117, "apiParameterId": 1212946, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": { "arrayRestriction": null, "lengthRestriction": { "lengthMax": 15, "lengthMin": 3 }, "numberRangeRestriction": null, "rangeRestriction": null, "xmlConversionRule": null }, "apiParameterType": "string", "apiResourceMethParamId": 494449, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 341592, "apiResourceMethodLogicId": 184405 } ], "apiResourceName": "books", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "A book item within the bookstore API.", "link": null, "lockVersion": 2, "private": false, "resourcePath": "/books/{bookId}", "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin" } ], "availableActions": [ "DELETE", "CLONE_ENDPOINT", "ACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING" ], "basePath": "/bookstore", "caseSensitive": true, "clonedFromVersion": 1, "consumeType": "any", "contractId": "C-0N7RAC71", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "endpointHidden": false, "groupId": 12345, "isGraphQL": false, "lockVersion": 2, "positiveConstrainsEnabled": null, "productionStatus": null, "productionVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "protectedByApiKey": true, "responseConstraintsEnabled": false, "securityScheme": { "securitySchemeDetail": { "apiKeyLocation": "header", "apiKeyName": "apikey" }, "securitySchemeType": "apikey" }, "source": null, "stagingStatus": null, "stagingVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin", "versionHidden": false, "versionNumber": 1 }, "schema": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in cookies. These booleans override fields in the Method object. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the field is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__Read-only__ Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__Read-only__ The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__Read-only__ Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__Read-only__ The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__Read-only__ Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An endpoint and its associated resources.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-response.yaml" } } } }, "description": "Operation succeeded." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Invalid data input.", "x-akamai": { "file-path": "errors/400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have access to the endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "Hide an endpoint", "tags": [ "Endpoints" ] }, "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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/endpoint-hide.yaml", "path-info": "/endpoints/{apiEndPointId}/hide" } }, "/endpoints/{apiEndPointId}/show": { "post": { "description": "Reveals a hidden endpoint and all its versions. A revealed endpoint appears in the [List endpoints](https://techdocs.akamai.com/api-definitions/reference/get-endpoints) operation's response object by default, or when you set the operation's `show` query parameter to `ONLY_VISIBLE`. Running this operation affects the endpoint listing in the API Definitions user interface.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show" }, "operationId": "post-endpoint-show", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "akamaiSecurityRestrictions": null, "apiCategoryIds": [ 2, 7 ], "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": 492375, "apiEndPointLocked": false, "apiEndPointName": "Bookstore API", "apiEndPointScheme": "http/https", "apiGatewayEnabled": true, "apiResources": [ { "apiResourceClonedFromId": null, "apiResourceId": 2926712, "apiResourceLogicId": 118435, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578116, "apiParameterId": 1212945, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 494448, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "GET", "apiResourceMethodId": 341591, "apiResourceMethodLogicId": 184404 }, { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578117, "apiParameterId": 1212946, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": { "arrayRestriction": null, "lengthRestriction": { "lengthMax": 15, "lengthMin": 3 }, "numberRangeRestriction": null, "rangeRestriction": null, "xmlConversionRule": null }, "apiParameterType": "string", "apiResourceMethParamId": 494449, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 341592, "apiResourceMethodLogicId": 184405 } ], "apiResourceName": "books", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "A book item within the bookstore API.", "link": null, "lockVersion": 2, "private": false, "resourcePath": "/books/{bookId}", "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin" } ], "availableActions": [ "DELETE", "CLONE_ENDPOINT", "ACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING" ], "basePath": "/bookstore", "caseSensitive": true, "clonedFromVersion": 1, "consumeType": "any", "contractId": "C-0N7RAC71", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "endpointHidden": false, "groupId": 12345, "isGraphQL": false, "lockVersion": 2, "positiveConstrainsEnabled": null, "productionStatus": null, "productionVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "protectedByApiKey": true, "responseConstraintsEnabled": false, "securityScheme": { "securitySchemeDetail": { "apiKeyLocation": "header", "apiKeyName": "apikey" }, "securitySchemeType": "apikey" }, "source": null, "stagingStatus": null, "stagingVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin", "versionHidden": false, "versionNumber": 1 }, "schema": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in cookies. These booleans override fields in the Method object. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the field is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__Read-only__ Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__Read-only__ The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__Read-only__ Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__Read-only__ The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__Read-only__ Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An endpoint and its associated resources.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-response.yaml" } } } }, "description": "Operation succeeded." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Invalid data input.", "x-akamai": { "file-path": "errors/400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have access to the endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "Show an endpoint", "tags": [ "Endpoints" ] }, "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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/endpoint-show.yaml", "path-info": "/endpoints/{apiEndPointId}/show" } }, "/endpoints/{apiEndPointId}/versions": { "get": { "description": "Returns versions of an endpoint, with results optionally paginated, sorted, and filtered.", "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" }, "operationId": "get-endpoint-versions", "parameters": [ { "description": "The page number index, starting at the default value of `1`.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "default": 1, "example": 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" }, "x-akamai": { "file-path": "parameters/page-size-version-query.yaml" } }, { "description": "__Enum__ The field to sort endpoint versions by, `versionNumber` by default.", "example": "{{sortBy}}", "in": "query", "name": "sortBy", "schema": { "default": "versionNumber", "enum": [ "versionNumber", "description", "updateDate", "updatedBy", "basedOn", "stagingStatus", "productionStatus" ], "example": "updateDate", "type": "string" }, "x-akamai": { "file-path": "parameters/sort-by-version-query.yaml" } }, { "description": "__Enum__ The sort order, either `asc` for ascending or the default `desc` for descending.", "example": "{{sortOrder}}", "in": "query", "name": "sortOrder", "schema": { "default": "desc", "enum": [ "asc", "desc" ], "example": "desc", "type": "string" }, "x-akamai": { "file-path": "parameters/sort-order-version-query.yaml" } }, { "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", "enum": [ "ALL", "ONLY_VISIBLE", "ONLY_HIDDEN" ], "example": "ONLY_VISIBLE", "type": "string" }, "x-akamai": { "file-path": "parameters/show-version-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "apiEndPointId": 492375, "apiEndPointName": "Bookstore API", "apiVersions": [ { "apiEndPointVersionId": 599104, "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" ], "basePath": "/bookstore2", "basedOn": 1, "createDate": "2019-06-17T07:22:29+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "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 }, { "apiEndPointVersionId": 574127, "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" ], "basePath": "/bookstore", "basedOn": null, "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "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 } ], "page": 1, "pageSize": 25, "totalSize": 50 }, "schema": { "additionalProperties": false, "description": "All versions of an endpoint.", "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": "Each endpoint version within a collection.", "items": { "additionalProperties": false, "properties": { "apiEndPointVersionId": { "description": "The unique identifier for the endpoint version.", "type": "integer" }, "availableActions": { "description": "Available [actions](https://techdocs.akamai.com/api-definitions/docs/api-config-version-mgmt#actions) that you can perform on the version depending on the version's activation status.", "items": { "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" ], "type": "string" }, "type": "array", "x-akamai": { "enum-descriptions": { "ACTIVATE_ON_PRODUCTION": "Activate on production. Available when version is inactive or deactivated.", "ACTIVATE_ON_STAGING": "Activate on staging. Available when version is inactive or deactivated.", "CLONE_ENDPOINT": "Clone the endpoint from another existing endpoint.", "CLONE_VERSION": "Clone a new version from another existing version.", "COMPARE_AAG_SETTINGS": "Compare AAG settings between different versions.", "COMPARE_ENDPOINT": "Compare the endpoint between different versions.", "COMPARE_RAPID_SETTINGS": "Compare RAPID settings between different versions.", "COMPARE_RESOURCE_PURPOSES": "Compare resource purposes between different versions.", "DEACTIVATE_ON_PRODUCTION": "Deactivate on production. Available when version is active.", "DEACTIVATE_ON_STAGING": "Deactivate on staging. Available when version is active.", "DELETE": "Delete the version. Only available for inactive versions.", "EDIT_AAG_SETTINGS": "Edit AAG settings.", "EDIT_ENDPOINT_DEFINITION": "Edit the endpoint definition.", "HIDE_VERSION": "Hide the version so that it no longer appears in the version history. You can't activate or delete hidden versions.", "RESOURCES": "View resources.", "SHOW_VERSION": "Reveal the version so that it becomes visible in the version history.", "VIEW_AAG_SETTINGS": "View AAG settings." } } }, "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 field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "basedOn": { "description": "For cloned versions, the unique identifier for the source version.", "nullable": true, "type": "integer" }, "createDate": { "description": "The ISO 8601 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 field from the object, the JSON response reflects it as an empty string.", "nullable": true, "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 8601 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.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "type": "string" }, "stagingDate": { "description": "The ISO 8601 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.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "type": "string" }, "updateDate": { "description": "The ISO 8601 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" } }, "required": [ "lockVersion", "versionNumber" ], "type": "object" }, "type": "array" }, "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" } }, "required": [ "apiEndPointId" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-list-dto.yaml" } } } }, "description": "Lists API endpoint versions you have access to in this account." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to retrieve the API endpoint versions list.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "List versions", "tags": [ "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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/versions.yaml", "path-info": "/endpoints/{apiEndPointId}/versions" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}": { "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).", "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" }, "operationId": "get-endpoint-version", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "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" ], "basePath": "/bookstore", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "productionStatus": "ACTIVE", "stagingStatus": "ACTIVE" }, "schema": { "additionalProperties": false, "description": "Contains summary information about a specific endpoint version.", "properties": { "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostname strings that may receive traffic for the endpoint.", "items": { "type": "string" }, "type": "array" }, "apiEndPointVersionId": { "description": "The unique identifier for the endpoint version.", "type": "integer" }, "apiResourceNames": { "description": "Resource names defined for the endpoint. The value is `null` for endpoints without any resources.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "availableActions": { "description": "Available [actions](https://techdocs.akamai.com/api-definitions/docs/api-config-version-mgmt#actions) that you can perform on the version depending on the version's activation status.", "items": { "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" ], "type": "string" }, "type": "array", "x-akamai": { "enum-descriptions": { "ACTIVATE_ON_PRODUCTION": "Activate on production. Available when version is inactive or deactivated.", "ACTIVATE_ON_STAGING": "Activate on staging. Available when version is inactive or deactivated.", "CLONE_ENDPOINT": "Clone the endpoint from another existing endpoint.", "CLONE_VERSION": "Clone a new version from another existing version.", "COMPARE_AAG_SETTINGS": "Compare AAG settings between different versions.", "COMPARE_ENDPOINT": "Compare the endpoint between different versions.", "COMPARE_RAPID_SETTINGS": "Compare RAPID settings between different versions.", "COMPARE_RESOURCE_PURPOSES": "Compare resource purposes between different versions.", "DEACTIVATE_ON_PRODUCTION": "Deactivate on production. Available when version is active.", "DEACTIVATE_ON_STAGING": "Deactivate on staging. Available when version is active.", "DELETE": "Delete the version. Only available for inactive versions.", "EDIT_AAG_SETTINGS": "Edit AAG settings.", "EDIT_ENDPOINT_DEFINITION": "Edit the endpoint definition.", "HIDE_VERSION": "Hide the version so that it no longer appears in the version history. You can't activate or delete hidden versions.", "RESOURCES": "View resources.", "SHOW_VERSION": "Reveal the version so that it becomes visible in the version history.", "VIEW_AAG_SETTINGS": "View AAG settings." } } }, "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 field from the object, the JSON response reflects it as an empty string.", "nullable": true, "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.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "type": "string" }, "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.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-version-summary-dto.yaml" } } } }, "description": "API Endpoint version summary defined by API Endpoint ID and Version Number." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have access to the endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } } }, "summary": "Get a version summary", "tags": [ "Versions" ] }, "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.", "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" }, "operationId": "put-endpoint-version", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "akamaiSecurityRestrictions": null, "apiCategoryIds": [], "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": 492375, "apiEndPointLocked": false, "apiEndPointName": "Bookstore API", "apiEndPointScheme": "http/https", "apiEndPointVersion": 574127, "apiGatewayEnabled": true, "apiResources": [ { "apiResourceClonedFromId": null, "apiResourceId": 2926712, "apiResourceLogicId": 118435, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578116, "apiParameterId": 1212945, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 494448, "array": false, "pathParamLocationId": 3, "response": false } ], "apiResourceMethod": "GET", "apiResourceMethodId": 341591, "apiResourceMethodLogicId": 184404 }, { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578117, "apiParameterId": 1212946, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": { "arrayRestriction": { "maxItems": 200, "minItems": 100 }, "numberRangeRestriction": null, "rangeRestriction": null, "responseRestriction": { "maxBodySize": "SIZE_6K", "statusCodes": [ 200, 201 ] }, "xmlConversionRule": null }, "apiParameterType": "string", "apiResourceMethParamId": 494449, "array": false, "pathParamLocationId": 3, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 341592, "apiResourceMethodLogicId": 184405 } ], "apiResourceName": "books", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "A book item within the bookstore API.", "link": null, "lockVersion": 0, "private": false, "resourcePath": "/books/{bookId}", "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin" } ], "availableActions": [ "DELETE", "CLONE_ENDPOINT", "ACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING" ], "basePath": "/bookstore", "caseSensitive": true, "clonedFromVersion": null, "consumeType": "any", "contractId": "K-0N7RAK71", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items and modify existing items.", "discoveredPiiIds": [ 455976 ], "endpointHidden": false, "groupId": 54321, "isGraphQL": false, "lockVersion": 0, "positiveConstrainsEnabled": true, "productionStatus": null, "productionVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "protectedByApiKey": true, "responseConstraintsEnabled": false, "securityScheme": { "securitySchemeDetail": { "apiKeyLocation": "header", "apiKeyName": "apikey" }, "securitySchemeType": "apikey" }, "source": null, "stagingStatus": null, "stagingVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "updateDate": "2019-06-12T13:06:55+0000", "updatedBy": "bookstore_admin", "versionHidden": false, "versionNumber": 1 }, "schema": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in cookies. These booleans override fields in the Method object. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the field is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__Read-only__ Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__Read-only__ The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__Read-only__ Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__Read-only__ The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__Read-only__ Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `json/xml`, or `urlencoded`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "json/xml", "urlencoded" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-request.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-request.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-request.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An endpoint and its associated resources.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "akamaiSecurityRestrictions": null, "apiCategoryIds": [], "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": 492375, "apiEndPointLocked": false, "apiEndPointName": "Bookstore API", "apiEndPointScheme": "http/https", "apiEndPointVersion": 574127, "apiGatewayEnabled": true, "apiResources": [ { "apiResourceClonedFromId": null, "apiResourceId": 2926712, "apiResourceLogicId": 118435, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578116, "apiParameterId": 1212945, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 494448, "array": false, "pathParamLocationId": 3, "response": false } ], "apiResourceMethod": "GET", "apiResourceMethodId": 341591, "apiResourceMethodLogicId": 184404 }, { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578117, "apiParameterId": 1212946, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": { "arrayRestriction": { "maxItems": 200, "minItems": 100 }, "numberRangeRestriction": null, "rangeRestriction": null, "responseRestriction": { "maxBodySize": "SIZE_6K", "statusCodes": [ 200, 201 ] }, "xmlConversionRule": null }, "apiParameterType": "string", "apiResourceMethParamId": 494449, "array": false, "pathParamLocationId": 3, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 341592, "apiResourceMethodLogicId": 184405 } ], "apiResourceName": "books", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "A book item within the bookstore API.", "link": null, "lockVersion": 0, "private": false, "resourcePath": "/books/{bookId}", "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin" } ], "availableActions": [ "DELETE", "CLONE_ENDPOINT", "ACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING" ], "basePath": "/bookstore", "caseSensitive": true, "clonedFromVersion": null, "consumeType": "any", "contractId": "K-0N7RAK71", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items and modify existing items.", "discoveredPiiIds": [ 455976 ], "endpointHidden": false, "groupId": 54321, "isGraphQL": false, "lockVersion": 0, "positiveConstrainsEnabled": true, "productionStatus": null, "productionVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "protectedByApiKey": true, "responseConstraintsEnabled": false, "securityScheme": { "securitySchemeDetail": { "apiKeyLocation": "header", "apiKeyName": "apikey" }, "securitySchemeType": "apikey" }, "source": null, "stagingStatus": null, "stagingVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "updateDate": "2019-06-12T13:06:55+0000", "updatedBy": "bookstore_admin", "versionHidden": false, "versionNumber": 1 }, "schema": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in cookies. These booleans override fields in the Method object. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the field is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__Read-only__ Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__Read-only__ The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__Read-only__ Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__Read-only__ The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__Read-only__ Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An endpoint and its associated resources.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-response.yaml" } } } }, "description": "Modify details of an endpoint version." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of the request input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have access to the endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "detail": "Conflict with current state of resource.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 409, "title": "Conflict", "type": "/api-definitions/error-types/conflict" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/api-definitions/reference/409)", "x-akamai": { "file-path": "errors/409.yaml" } } }, "summary": "Edit a version", "tags": [ "Versions" ] }, "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.", "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" }, "operationId": "delete-endpoint-version", "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" } } ], "responses": { "204": { "content": {}, "description": "Resource successfully deleted." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have access to the endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } } }, "summary": "Delete a version", "tags": [ "Versions" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/version-number.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/activate": { "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.", "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" }, "operationId": "post-endpoint-version-activate", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "networks": [ "STAGING", "PRODUCTION" ], "notes": "Activating the first version of the Bookstore API on both staging and production networks.", "notificationRecipients": [ "bookstore_shared@akamai.com" ] }, "schema": { "additionalProperties": false, "description": "An endpoint version activation.", "properties": { "networks": { "description": "The network environments where you activate the endpoint version, either `STAGING` or `PRODUCTION`.", "items": { "enum": [ "STAGING", "PRODUCTION" ], "type": "string" }, "type": "array" }, "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "networks" ], "type": "object", "x-akamai": { "file-path": "schemas/activation-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "networks": [ "STAGING", "PRODUCTION" ], "notes": "Activating the first version of the Bookstore API on both staging and production networks.", "notificationRecipients": [ "bookstore_shared@akamai.com" ] }, "schema": { "additionalProperties": false, "description": "An endpoint version activation.", "properties": { "networks": { "description": "The network environments where you activate the endpoint version, either `STAGING` or `PRODUCTION`.", "items": { "enum": [ "STAGING", "PRODUCTION" ], "type": "string" }, "type": "array" }, "notes": { "description": "The notes describing the version that you activate.", "type": "string" }, "notificationRecipients": { "description": "The email addresses where the system sends the activation notification.", "items": { "type": "string" }, "type": "array" } }, "required": [ "networks" ], "type": "object", "x-akamai": { "file-path": "schemas/activation-dto.yaml" } } } }, "description": "Returns the activated entity." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of the input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } } }, "summary": "Activate a version", "tags": [ "Versions" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/activate.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/activate" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/cloneVersion": { "post": { "description": "Creates a new endpoint version as a clone of an existing version. The system assigns a new number to the version that you clone.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-clone" }, "operationId": "post-endpoint-version-clone", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "akamaiSecurityRestrictions": null, "apiCategoryIds": [ 2, 7 ], "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": 492375, "apiEndPointLocked": false, "apiEndPointName": "Bookstore API Premium", "apiEndPointScheme": "http/https", "apiEndPointVersion": 574127, "apiResources": [ { "apiResourceClonedFromId": null, "apiResourceId": 2926712, "apiResourceLogicId": 118435, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578116, "apiParameterId": 1212945, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 494448, "array": false, "pathParamLocationId": null } ], "apiResourceMethod": "GET", "apiResourceMethodId": 341591, "apiResourceMethodLogicId": 184404 }, { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578117, "apiParameterContentType": "json", "apiParameterId": 1212946, "apiParameterLocation": "body", "apiParameterName": "books", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": { "arrayRestriction": null, "lengthRestriction": { "lengthMax": 15, "lengthMin": 3 }, "numberRangeRestriction": null, "rangeRestriction": null, "xmlConversionRule": null }, "apiParameterType": "string", "apiResourceMethParamId": 494449, "array": true, "pathParamLocationId": null } ], "apiResourceMethod": "POST", "apiResourceMethodId": 341592, "apiResourceMethodLogicId": 184405 } ], "apiResourceName": "books", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "A book item within the bookstore API.", "link": null, "lockVersion": 2, "private": false, "resourcePath": "/books/{bookId}", "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin" } ], "availableActions": [ "DELETE", "CLONE_ENDPOINT", "ACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING" ], "basePath": "/bookstore-premium", "caseSensitive": true, "clonedFromVersion": 1, "consumeType": "any", "contractId": "C-0N7RAC71", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "endpointHidden": false, "groupId": 12345, "isGraphQL": false, "lockVersion": 2, "positiveConstrainsEnabled": null, "productionStatus": null, "productionVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "protectedByApiKey": true, "securityScheme": { "securitySchemeDetail": { "apiKeyLocation": "header", "apiKeyName": "apikey" }, "securitySchemeType": "apikey" }, "source": null, "stagingStatus": null, "stagingVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin", "versionHidden": false, "versionNumber": 2 }, "schema": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in cookies. These booleans override fields in the Method object. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the field is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__Read-only__ Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__Read-only__ The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__Read-only__ Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__Read-only__ The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__Read-only__ Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An endpoint and its associated resources.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-response.yaml" } } } }, "description": "Updated API Endpoint." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have access to the endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "detail": "Conflict with current state of resource.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 409, "title": "Conflict", "type": "/api-definitions/error-types/conflict" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/api-definitions/reference/409).", "x-akamai": { "file-path": "errors/409.yaml" } } }, "summary": "Clone a version", "tags": [ "Versions" ] }, "parameters": [ { "description": "The unique identifier for the endpoint version.", "example": "{{versionNumber}}", "in": "path", "name": "versionNumber", "required": true, "schema": { "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/version-number-path.yaml" } }, { "description": "The unique identifier for the endpoint.", "example": "{{apiEndPointId}}", "in": "path", "name": "apiEndPointId", "required": true, "schema": { "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/clone-version.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/cloneVersion" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/deactivate": { "post": { "description": "Deactivates an endpoint version on the staging or production network. A deactivated endpoint version no longer serves traffic through the Akamai network.", "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" }, "operationId": "post-endpoint-version-deactivate", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "networks": [ "STAGING", "PRODUCTION" ], "notes": "Activating the first version of the Bookstore API on both staging and production networks.", "notificationRecipients": [ "bookstore_shared@akamai.com" ] }, "schema": { "additionalProperties": false, "description": "An endpoint version activation.", "properties": { "networks": { "description": "The network environments where you activate the endpoint version, either `STAGING` or `PRODUCTION`.", "items": { "enum": [ "STAGING", "PRODUCTION" ], "type": "string" }, "type": "array" }, "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "networks" ], "type": "object", "x-akamai": { "file-path": "schemas/activation-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "networks": [ "STAGING", "PRODUCTION" ], "notes": "Activating the first version of the Bookstore API on both staging and production networks.", "notificationRecipients": [ "bookstore_shared@akamai.com" ] }, "schema": { "additionalProperties": false, "description": "An endpoint version activation.", "properties": { "networks": { "description": "The network environments where you activate the endpoint version, either `STAGING` or `PRODUCTION`.", "items": { "enum": [ "STAGING", "PRODUCTION" ], "type": "string" }, "type": "array" }, "notes": { "description": "The notes describing the version that you activate.", "type": "string" }, "notificationRecipients": { "description": "The email addresses where the system sends the activation notification.", "items": { "type": "string" }, "type": "array" } }, "required": [ "networks" ], "type": "object", "x-akamai": { "file-path": "schemas/activation-dto.yaml" } } } }, "description": "Returns deactivated entity." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of the request input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } } }, "summary": "Deactivate a version", "tags": [ "Versions" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/deactivate.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/deactivate" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/file": { "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.", "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" }, "operationId": "post-endpoint-version-file", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "contractId": "K-0N7RAK71", "groupId": 32145, "importFileContent": "ewogICJzd2FnZ2Vy ... ICAgfQogIH0KfQ==", "importFileFormat": "swagger", "importFileSource": "BODY_BASE64" }, "schema": { "additionalProperties": false, "description": "An API definition file to import.", "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": "integer" }, "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 can import RAML 0.8 files and Swagger 2.0 or 3.0 files.", "enum": [ "raml", "swagger" ], "example": "{{importFileFormat}}", "type": "string" }, "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.", "enum": [ "URL", "BODY_BASE64" ], "example": "{{importFileSource}}", "type": "string" }, "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" } }, "required": [ "importFileFormat", "importFileSource" ], "type": "object", "x-akamai": { "file-path": "schemas/import-file-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "akamaiSecurityRestrictions": null, "apiCategoryIds": [ 2, 7 ], "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": 492375, "apiEndPointLocked": false, "apiEndPointName": "Bookstore API", "apiEndPointScheme": "http/https", "apiGatewayEnabled": true, "apiResources": [ { "apiResourceClonedFromId": null, "apiResourceId": 2926712, "apiResourceLogicId": 118435, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578116, "apiParameterId": 1212945, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 494448, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "GET", "apiResourceMethodId": 341591, "apiResourceMethodLogicId": 184404 }, { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578117, "apiParameterId": 1212946, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": { "arrayRestriction": null, "lengthRestriction": { "lengthMax": 15, "lengthMin": 3 }, "numberRangeRestriction": null, "rangeRestriction": null, "xmlConversionRule": null }, "apiParameterType": "string", "apiResourceMethParamId": 494449, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 341592, "apiResourceMethodLogicId": 184405 } ], "apiResourceName": "books", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "A book item within the bookstore API.", "link": null, "lockVersion": 2, "private": false, "resourcePath": "/books/{bookId}", "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin" } ], "availableActions": [ "DELETE", "CLONE_ENDPOINT", "ACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING" ], "basePath": "/bookstore", "caseSensitive": true, "clonedFromVersion": 1, "consumeType": "any", "contractId": "C-0N7RAC71", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "endpointHidden": false, "groupId": 12345, "isGraphQL": false, "lockVersion": 2, "positiveConstrainsEnabled": null, "productionStatus": null, "productionVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "protectedByApiKey": true, "responseConstraintsEnabled": false, "securityScheme": { "securitySchemeDetail": { "apiKeyLocation": "header", "apiKeyName": "apikey" }, "securitySchemeType": "apikey" }, "source": null, "stagingStatus": null, "stagingVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin", "versionHidden": false, "versionNumber": 1 }, "schema": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in cookies. These booleans override fields in the Method object. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the field is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__Read-only__ Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__Read-only__ The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__Read-only__ Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__Read-only__ The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__Read-only__ Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An endpoint and its associated resources.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-response.yaml" } } } }, "description": "Operation succeeded." }, "400": { "content": { "application/problem+json": { "example": { "apiEndpointDetails": { "akamaiSecurityRestrictions": null, "apiCategoryIds": null, "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": null, "apiEndPointLocked": null, "apiEndPointName": "Bookstore API", "apiEndPointScheme": "http/https", "apiResources": [], "basePath": "/bookstore", "clonedFromVersion": null, "consumeType": "any", "contractId": "K-0N7RAK7", "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 }, "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": "A result of an import operation, including endpoint details and a list of potential issues.", "properties": { "apiEndpointDetails": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in cookies. These booleans override fields in the Method object. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the field is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__Read-only__ Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__Read-only__ The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__Read-only__ Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__Read-only__ The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__Read-only__ Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "The imported endpoint.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-response.yaml" } }, "problems": { "description": "Problems that occurred during the import, such as schema errors or unsupported property warnings.", "items": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/import-result.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of the file input data is invalid.", "x-akamai": { "file-path": "errors/400-import.yaml" } } }, "summary": "Edit an endpoint from an API definition file", "tags": [ "Versions" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/file.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/file" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/hide": { "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.", "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" }, "operationId": "post-endpoint-version-hide", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "akamaiSecurityRestrictions": null, "apiCategoryIds": [ 2, 7 ], "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": 492375, "apiEndPointLocked": false, "apiEndPointName": "Bookstore API", "apiEndPointScheme": "http/https", "apiGatewayEnabled": true, "apiResources": [ { "apiResourceClonedFromId": null, "apiResourceId": 2926712, "apiResourceLogicId": 118435, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578116, "apiParameterId": 1212945, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 494448, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "GET", "apiResourceMethodId": 341591, "apiResourceMethodLogicId": 184404 }, { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578117, "apiParameterId": 1212946, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": { "arrayRestriction": null, "lengthRestriction": { "lengthMax": 15, "lengthMin": 3 }, "numberRangeRestriction": null, "rangeRestriction": null, "xmlConversionRule": null }, "apiParameterType": "string", "apiResourceMethParamId": 494449, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 341592, "apiResourceMethodLogicId": 184405 } ], "apiResourceName": "books", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "A book item within the bookstore API.", "link": null, "lockVersion": 2, "private": false, "resourcePath": "/books/{bookId}", "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin" } ], "availableActions": [ "DELETE", "CLONE_ENDPOINT", "ACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING" ], "basePath": "/bookstore", "caseSensitive": true, "clonedFromVersion": 1, "consumeType": "any", "contractId": "C-0N7RAC71", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "endpointHidden": false, "groupId": 12345, "isGraphQL": false, "lockVersion": 2, "positiveConstrainsEnabled": null, "productionStatus": null, "productionVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "protectedByApiKey": true, "responseConstraintsEnabled": false, "securityScheme": { "securitySchemeDetail": { "apiKeyLocation": "header", "apiKeyName": "apikey" }, "securitySchemeType": "apikey" }, "source": null, "stagingStatus": null, "stagingVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin", "versionHidden": false, "versionNumber": 1 }, "schema": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in cookies. These booleans override fields in the Method object. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the field is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__Read-only__ Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__Read-only__ The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__Read-only__ Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__Read-only__ The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__Read-only__ Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An endpoint and its associated resources.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-response.yaml" } } } }, "description": "Operation succeeded." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Invalid data input.", "x-akamai": { "file-path": "errors/400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have access to the endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "Hide a version", "tags": [ "Versions" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/version-hide.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/hide" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/piis": { "get": { "description": "Returns all PII objects for an endpoint version. This includes parameters with PII already in your API definition, as well as parameters with PII the network discovers on your behalf. You can return this information for both active and inactive endpoint versions. All operations for PII are per endpoint version. Run [Enable PII learning settings for a configuration](https://techdocs.akamai.com/application-security/reference/put-advanced-settings-pii-learning) to use this feature.", "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-piis" }, "operationId": "get-endpoint-version-piis", "parameters": [ { "description": "__Enum__ The status of an instance of personally identifiable information (PII) discovered on the network. See [PII status](https://techdocs.akamai.com/api-definitions/reference/personally-identifiable-information-status).", "example": "{{status}}", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "DISCOVERED", "CONFIRMED", "DEFERRED" ], "example": "DISCOVERED", "type": "string" }, "x-akamai": { "file-path": "parameters/pii-status-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "piis": [ { "contentType": "json", "dateFirstSeen": "2021-12-16", "id": 1, "lastAction": null, "location": "body", "method": "GET", "newPii": true, "parameterId": 1, "parameterName": "email", "parameterPath": "/person/email", "resourceName": "Persons resource", "resourcePath": "/bookstore/persons", "response": false, "status": "DISCOVERED", "statusCodes": [], "type": "PERSONAL_EMAIL", "userCreated": false }, { "contentType": "json", "dateFirstSeen": "2021-12-10", "id": 2, "lastAction": { "by": "bookstore_admin", "date": "2021-12-16" }, "location": "body", "method": "POST", "newPii": false, "parameterId": 2, "parameterName": "email", "parameterPath": "/person/email", "resourceName": "Persons resource", "resourcePath": "/bookstore/persons", "response": true, "status": "CONFIRMED", "statusCodes": [], "type": "PERSONAL_EMAIL", "userCreated": false } ] }, "schema": { "additionalProperties": false, "description": "Specifies personally identifiable information (PII) found or defined in an API endpoint version.", "properties": { "piis": { "description": "PII objects describing the kind of PII and where it appears in API payloads.", "items": { "additionalProperties": false, "description": "Describes a personally identifiable information (PII) object.", "properties": { "contentType": { "description": "The content type of the payload in which PII exists. Supported values are `json`, `xml`, and `urlencoded`.", "enum": [ "json", "xml", "urlencoded" ], "type": "string" }, "dateFirstSeen": { "description": "The date when PII was added to an API endpoint definition either by you or the network.", "format": "date", "type": "string" }, "id": { "description": "The unique identifier for a PII object.", "type": "integer" }, "lastAction": { "additionalProperties": false, "description": "Describes the last action made by an end user.", "nullable": true, "properties": { "by": { "description": "The username of the person who made the change.", "type": "string" }, "date": { "description": "The ISO 8601 timestamp the action was taken.", "format": "date", "type": "string" } }, "type": "object" }, "location": { "description": "The payload location where the parameter with PII exists, the `path`, `header`, `cookie`, `query`, or `body`.", "enum": [ "path", "header", "cookie", "query", "body" ], "type": "string" }, "method": { "description": "The HTTP method for the call in which PII exists.", "type": "string" }, "newPii": { "description": "Whether the PII is new. The new PII found by the network has a status of `discovered` until any action changes it.", "type": "boolean" }, "parameterId": { "description": "Uniquely identifies parameters containing PII.", "nullable": true, "type": "integer" }, "parameterName": { "description": "The name of the parameter that contains PII.", "nullable": true, "type": "string" }, "parameterPath": { "description": "The parameter path where the PII exists, with segments delimited by `/`.", "type": "string" }, "resourceName": { "description": "The name of the resource in which PII exists.", "nullable": true, "type": "string" }, "resourcePath": { "description": "The URL path in which PII exists.", "type": "string" }, "response": { "description": "Whether the PII is registered in the response. When `false`, the parameter is in the request.", "type": "boolean" }, "status": { "description": "Describes the status of the personally identifiable information (PII) found in a parameter. See [PII status](https://techdocs.akamai.com/api-definitions/reference/personally-identifiable-information-status).", "enum": [ "DISCOVERED", "CONFIRMED", "DEFERRED", "DECLINED" ], "type": "string", "x-akamai": { "file-path": "schemas/pii-status.yaml" } }, "statusCodes": { "description": "Status codes for which PII exists. If the response contains PII, it lists the possible response codes. For a request the array is empty.", "items": { "type": "integer" }, "type": "array" }, "type": { "description": "Classifies PII as either `PERSONAL_EMAIL` or `CREDIT_OR_DEBIT_CARD_NUMBER`.", "enum": [ "PERSONAL_EMAIL", "CREDIT_OR_DEBIT_CARD_NUMBER" ], "type": "string", "x-akamai": { "file-path": "schemas/pii-type.yaml" } }, "userCreated": { "description": "When `true`, you defined PII using the API or Control Center. When `false`, the PII is discovered by the network.", "type": "boolean" } }, "required": [ "type", "parameterId" ], "type": "object", "x-akamai": { "file-path": "schemas/pii-dto.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/pii-list-dto.yaml" } } } }, "description": "Successfully retrieved parameters with PII for this version." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint PII list.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "List parameters with PII for an endpoint version", "tags": [ "Personally identifiable information" ] }, "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/api-end-point-id-path.yaml" } }, { "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/version-number-path.yaml" } } ], "x-akamai": { "file-path": "paths/piis.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/piis" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/piis/parameters/{paramId}": { "post": { "description": "Adds or updates PII in an API parameter. This is for you to add to or modify in your API definition yourself, rather than the network discovering the PII for you.", "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-piis-parameter" }, "operationId": "post-endpoint-version-piis-parameter", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "types": [ "PERSONAL_EMAIL" ] }, "schema": { "additionalProperties": false, "description": "PII list you want to add to the parameter.", "properties": { "types": { "description": "The set of PII types you want to add to the parameter. The API supports `PERSONAL_EMAIL` or `CREDIT_OR_DEBIT_CARD_NUMBER`.", "items": { "enum": [ "PERSONAL_EMAIL", "CREDIT_OR_DEBIT_CARD_NUMBER" ], "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/pii-update-type-dto.yaml" } } } }, "required": true }, "responses": { "204": { "content": {}, "description": "Successfully added or updated PII." }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). Can't find the parameter ID.", "x-akamai": { "file-path": "errors/404.yaml" } } }, "summary": "Add or update a user-created PII instance", "tags": [ "Personally identifiable information" ] }, "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/api-end-point-id-path.yaml" } }, { "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/version-number-path.yaml" } }, { "description": "The unique identifier for a parameter.", "example": "{{paramId}}", "in": "path", "name": "paramId", "required": true, "schema": { "example": 1355468, "type": "integer" }, "x-akamai": { "file-path": "parameters/param-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/param.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/piis/parameters/{paramId}" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/piis/settings": { "post": { "description": "Update the PII settings in an endpoint version. These settings are for a PII object per endpoint version, so if you have the same object in multiple endpoint versions, you'll need to run the operation for each version. This includes parameters with PII already in your API definition, as well as parameters with PII the network discovers on your behalf. You can return this information for both active and inactive endpoint versions. All operations for PII are per endpoint version. Run [Enable PII learning settings for a configuration](https://techdocs.akamai.com/application-security/reference/put-advanced-settings-pii-learning) to use this feature.", "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-pii-settings" }, "operationId": "post-endpoint-version-pii-settings", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "constraints": { "requestEnabled": true, "resources": [], "responseEnabled": true, "scope": "API", "types": { "allTypes": true, "specific": [] } }, "exclusions": [] }, "schema": { "additionalProperties": false, "description": "Describes the full PII object.", "properties": { "constraints": { "additionalProperties": false, "description": "Describes how and where to look for personally identifiable information (PII) in your API payloads.", "properties": { "requestEnabled": { "description": "Whether the network looks for PII in the request payloads.", "type": "boolean" }, "resources": { "description": "Resources you want the network to inspect.", "items": { "additionalProperties": false, "description": "The resource you want network to inspect.", "properties": { "allMethods": { "description": "Whether the network looks for PII in all methods.", "type": "boolean" }, "methods": { "description": "The methods you want the network to inspect. Supported values are `get`, `put`, `post`, `delete`, `head`, `patch`, and `options`.", "items": { "description": "A unique identifier for a method.", "enum": [ "get", "put", "post", "delete", "head", "patch", "options" ], "type": "string" }, "type": "array" }, "resourceId": { "description": "A unique identifier for a resource.", "type": "integer" } }, "required": [ "resourceId", "allMethods", "methods" ], "type": "object" }, "type": "array" }, "responseEnabled": { "description": "Whether the network looks for PII in the response payloads.", "type": "boolean" }, "scope": { "description": "The extent to which the network should inspect your API and enforce constraints you set. Use `NONE` to let all traffic though as if PII discovery is disabled. Use `API` to inspect and enforce constraints for every resource and method in your API. Use `RESOURCES_AND_METHODS` to inspect specific resources and methods within your API.", "enum": [ "NONE", "API", "RESOURCES_AND_METHODS" ], "type": "string" }, "types": { "additionalProperties": false, "description": "Use `allTypes` to identify all PII types in a parameter, or `specific` to identify individual PII types you choose. Email and credit or debit cards are supported.", "properties": { "allTypes": { "description": "Whether the network looks for all PII types.", "type": "boolean" }, "specific": { "description": "The PII types to inspect, either `PERSONAL_EMAIL` or `CREDIT_OR_DEBIT_CARD_NUMBER`.", "items": { "description": "Classifies PII as either `PERSONAL_EMAIL` or `CREDIT_OR_DEBIT_CARD_NUMBER`.", "enum": [ "PERSONAL_EMAIL", "CREDIT_OR_DEBIT_CARD_NUMBER" ], "type": "string", "x-akamai": { "file-path": "schemas/pii-type.yaml" } }, "type": "array" } }, "required": [ "allTypes", "specific" ], "type": "object" } }, "required": [ "scope", "requestEnabled", "responseEnabled", "types", "resources" ], "type": "object", "x-akamai": { "file-path": "schemas/pii-constraints-dto.yaml" } }, "exclusions": { "description": "Parameters you want to exclude from inspecting and enforcing constraints.", "items": { "additionalProperties": false, "description": "Describes the properties necessary to exclude parameters from PII inspection.", "properties": { "exclusionId": { "description": "A unique identifier for a an exclusion object.", "nullable": true, "type": "integer" }, "parameterId": { "description": "A unique identifier of the parameter you want to exclude.", "type": "integer" } }, "required": [ "parameterId" ], "type": "object", "x-akamai": { "file-path": "schemas/pii-exclusion-dto.yaml" } }, "type": "array" } }, "required": [ "constraints", "exclusions" ], "type": "object", "x-akamai": { "file-path": "schemas/pii-settings-dto.yaml" } } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "2-all-enabled": { "summary": "All enabled", "value": { "constraints": { "requestEnabled": true, "resources": [], "responseEnabled": true, "scope": "API", "types": { "allTypes": true, "specific": [] } }, "exclusions": [ { "exclusionId": 1, "parameterId": 11 }, { "exclusionId": 2, "parameterId": 21 } ] } }, "3-all-disabled": { "summary": "All disabled", "value": { "constraints": { "requestEnabled": false, "resources": [], "responseEnabled": false, "scope": "NONE", "types": { "allTypes": true, "specific": [] } }, "exclusions": [] } }, "4-partially-enabled": { "summary": "Partially enabled", "value": { "constraints": { "requestEnabled": true, "resources": [ { "allMethods": false, "methods": [ "post", "patch" ], "resourceId": 1 } ], "responseEnabled": false, "scope": "RESOURCES_AND_METHODS", "types": { "allTypes": false, "specific": [ "PERSONAL_EMAIL" ] } }, "exclusions": [] } } }, "schema": { "additionalProperties": false, "description": "Describes the full PII object.", "properties": { "constraints": { "additionalProperties": false, "description": "Describes how and where to look for personally identifiable information (PII) in your API payloads.", "properties": { "requestEnabled": { "description": "Whether the network looks for PII in the request payloads.", "type": "boolean" }, "resources": { "description": "Resources you want the network to inspect.", "items": { "additionalProperties": false, "description": "The resource you want network to inspect.", "properties": { "allMethods": { "description": "Whether the network looks for PII in all methods.", "type": "boolean" }, "methods": { "description": "The methods you want the network to inspect. Supported values are `get`, `put`, `post`, `delete`, `head`, `patch`, and `options`.", "items": { "description": "A unique identifier for a method.", "enum": [ "get", "put", "post", "delete", "head", "patch", "options" ], "type": "string" }, "type": "array" }, "resourceId": { "description": "A unique identifier for a resource.", "type": "integer" } }, "required": [ "resourceId", "allMethods", "methods" ], "type": "object" }, "type": "array" }, "responseEnabled": { "description": "Whether the network looks for PII in the response payloads.", "type": "boolean" }, "scope": { "description": "The extent to which the network should inspect your API and enforce constraints you set. Use `NONE` to let all traffic though as if PII discovery is disabled. Use `API` to inspect and enforce constraints for every resource and method in your API. Use `RESOURCES_AND_METHODS` to inspect specific resources and methods within your API.", "enum": [ "NONE", "API", "RESOURCES_AND_METHODS" ], "type": "string" }, "types": { "additionalProperties": false, "description": "Use `allTypes` to identify all PII types in a parameter, or `specific` to identify individual PII types you choose. Email and credit or debit cards are supported.", "properties": { "allTypes": { "description": "Whether the network looks for all PII types.", "type": "boolean" }, "specific": { "description": "The PII types to inspect, either `PERSONAL_EMAIL` or `CREDIT_OR_DEBIT_CARD_NUMBER`.", "items": { "description": "Classifies PII as either `PERSONAL_EMAIL` or `CREDIT_OR_DEBIT_CARD_NUMBER`.", "enum": [ "PERSONAL_EMAIL", "CREDIT_OR_DEBIT_CARD_NUMBER" ], "type": "string", "x-akamai": { "file-path": "schemas/pii-type.yaml" } }, "type": "array" } }, "required": [ "allTypes", "specific" ], "type": "object" } }, "required": [ "scope", "requestEnabled", "responseEnabled", "types", "resources" ], "type": "object", "x-akamai": { "file-path": "schemas/pii-constraints-dto.yaml" } }, "exclusions": { "description": "Parameters you want to exclude from inspecting and enforcing constraints.", "items": { "additionalProperties": false, "description": "Describes the properties necessary to exclude parameters from PII inspection.", "properties": { "exclusionId": { "description": "A unique identifier for a an exclusion object.", "nullable": true, "type": "integer" }, "parameterId": { "description": "A unique identifier of the parameter you want to exclude.", "type": "integer" } }, "required": [ "parameterId" ], "type": "object", "x-akamai": { "file-path": "schemas/pii-exclusion-dto.yaml" } }, "type": "array" } }, "required": [ "constraints", "exclusions" ], "type": "object", "x-akamai": { "file-path": "schemas/pii-settings-dto.yaml" } } } }, "description": "Successfully updated the endpoint version." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to update PII settings.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "Modify PII settings for an endpoint version", "tags": [ "Personally identifiable information" ] }, "get": { "description": "Returns the PII settings in an endpoint version, including the inspection scope and constraints, and how you want the network to handle PII.", "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-pii-settings" }, "operationId": "get-endpoint-version-pii-settings", "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" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "1-security-config": { "summary": "Security config", "value": { "constraints": { "requestEnabled": true, "resources": [], "responseEnabled": true, "scope": "API", "types": { "allTypes": true, "specific": [] } }, "exclusions": [ { "exclusionId": 1, "parameterId": 11 }, { "exclusionId": 2, "parameterId": 21 } ] } }, "2-all-enabled": { "summary": "All enabled", "value": { "constraints": { "requestEnabled": true, "resources": [], "responseEnabled": true, "scope": "API", "types": { "allTypes": true, "specific": [] } }, "exclusions": [ { "exclusionId": 1, "parameterId": 11 }, { "exclusionId": 2, "parameterId": 21 } ] } }, "3-all-disabled": { "summary": "All disabled", "value": { "constraints": { "requestEnabled": false, "resources": [], "responseEnabled": false, "scope": "NONE", "types": { "allTypes": true, "specific": [] } }, "exclusions": [] } }, "4-partially-enabled": { "summary": "Partially enabled", "value": { "constraints": { "requestEnabled": true, "resources": [ { "allMethods": false, "methods": [ "post", "patch" ], "resourceId": 1 } ], "responseEnabled": false, "scope": "RESOURCES_AND_METHODS", "types": { "allTypes": false, "specific": [ "PERSONAL_EMAIL" ] } }, "exclusions": [] } } }, "schema": { "additionalProperties": false, "description": "Describes the full PII object.", "properties": { "constraints": { "additionalProperties": false, "description": "Describes how and where to look for personally identifiable information (PII) in your API payloads.", "properties": { "requestEnabled": { "description": "Whether the network looks for PII in the request payloads.", "type": "boolean" }, "resources": { "description": "Resources you want the network to inspect.", "items": { "additionalProperties": false, "description": "The resource you want network to inspect.", "properties": { "allMethods": { "description": "Whether the network looks for PII in all methods.", "type": "boolean" }, "methods": { "description": "The methods you want the network to inspect. Supported values are `get`, `put`, `post`, `delete`, `head`, `patch`, and `options`.", "items": { "description": "A unique identifier for a method.", "enum": [ "get", "put", "post", "delete", "head", "patch", "options" ], "type": "string" }, "type": "array" }, "resourceId": { "description": "A unique identifier for a resource.", "type": "integer" } }, "required": [ "resourceId", "allMethods", "methods" ], "type": "object" }, "type": "array" }, "responseEnabled": { "description": "Whether the network looks for PII in the response payloads.", "type": "boolean" }, "scope": { "description": "The extent to which the network should inspect your API and enforce constraints you set. Use `NONE` to let all traffic though as if PII discovery is disabled. Use `API` to inspect and enforce constraints for every resource and method in your API. Use `RESOURCES_AND_METHODS` to inspect specific resources and methods within your API.", "enum": [ "NONE", "API", "RESOURCES_AND_METHODS" ], "type": "string" }, "types": { "additionalProperties": false, "description": "Use `allTypes` to identify all PII types in a parameter, or `specific` to identify individual PII types you choose. Email and credit or debit cards are supported.", "properties": { "allTypes": { "description": "Whether the network looks for all PII types.", "type": "boolean" }, "specific": { "description": "The PII types to inspect, either `PERSONAL_EMAIL` or `CREDIT_OR_DEBIT_CARD_NUMBER`.", "items": { "description": "Classifies PII as either `PERSONAL_EMAIL` or `CREDIT_OR_DEBIT_CARD_NUMBER`.", "enum": [ "PERSONAL_EMAIL", "CREDIT_OR_DEBIT_CARD_NUMBER" ], "type": "string", "x-akamai": { "file-path": "schemas/pii-type.yaml" } }, "type": "array" } }, "required": [ "allTypes", "specific" ], "type": "object" } }, "required": [ "scope", "requestEnabled", "responseEnabled", "types", "resources" ], "type": "object", "x-akamai": { "file-path": "schemas/pii-constraints-dto.yaml" } }, "exclusions": { "description": "Parameters you want to exclude from inspecting and enforcing constraints.", "items": { "additionalProperties": false, "description": "Describes the properties necessary to exclude parameters from PII inspection.", "properties": { "exclusionId": { "description": "A unique identifier for a an exclusion object.", "nullable": true, "type": "integer" }, "parameterId": { "description": "A unique identifier of the parameter you want to exclude.", "type": "integer" } }, "required": [ "parameterId" ], "type": "object", "x-akamai": { "file-path": "schemas/pii-exclusion-dto.yaml" } }, "type": "array" } }, "required": [ "constraints", "exclusions" ], "type": "object", "x-akamai": { "file-path": "schemas/pii-settings-dto.yaml" } } } }, "description": "Successfully fetched PII settings." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to get API endpoint PII settings.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "List PII settings for an endpoint version", "tags": [ "Personally identifiable information" ] }, "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/api-end-point-id-path.yaml" } }, { "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/version-number-path.yaml" } } ], "x-akamai": { "file-path": "paths/settings.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/piis/settings" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/piis/status": { "post": { "description": "Update the PII status. This operation applies to PII found by the network and not PII you add to your API definition yourself.", "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-pii-status-from-register-form" }, "operationId": "post-endpoint-version-pii-status-from-register-form", "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" } } ], "requestBody": { "content": { "application/json": { "example": [ { "id": 1209248, "status": "DECLINED" } ], "schema": { "description": "Describes the status of personally identifiable information (PII) found by the network.", "items": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier for the parameter containing PII.", "type": "integer" }, "status": { "description": "The status of PII found by the network. Either `DECLINED`, `DEFERRED`, or `CONFIRMED`. See [PII status](https://techdocs.akamai.com/api-definitions/reference/personally-identifiable-information-status) for more information.", "enum": [ "DECLINED", "DEFERRED", "CONFIRMED" ], "type": "string" } }, "type": "object" }, "type": "array", "x-akamai": { "file-path": "schemas/pii-update-status-per-param-id-dto.yaml" } } } }, "required": true }, "responses": { "204": { "content": {}, "description": "Successfully updated the PII status." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to update PII status.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } } }, "summary": "Modify PII status per endpoint version", "tags": [ "Personally identifiable information" ] }, "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/api-end-point-id-path.yaml" } }, { "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/version-number-path.yaml" } } ], "x-akamai": { "file-path": "paths/piis-status.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/piis/status" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/piis/{piiId}": { "delete": { "description": "Removes a PII object from your API endpoint definition for the version you specify. If you want to delete the PII object from all the versions where it exists, you'll need to make this request for each version of the endpoint.", "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-pii" }, "operationId": "delete-endpoint-version-pii", "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" } } ], "responses": { "204": { "content": {}, "description": "Successfully deleted the PII object from the endpoint version." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to delete PII for this endpoint version.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "Delete PII in an endpoint version", "tags": [ "Personally identifiable information" ] }, "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/api-end-point-id-path.yaml" } }, { "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/version-number-path.yaml" } }, { "description": "The unique identifier for the PII object.", "example": "{{piiId}}", "in": "path", "name": "piiId", "required": true, "schema": { "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/pii-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/pii.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/piis/{piiId}" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/piis/{piiId}/status": { "patch": { "description": "Update the PII status. This operation applies to PII found by the network and not PII you add to your API definition yourself.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/patch-endpoint-version-pii-status" }, "operationId": "patch-endpoint-version-pii-status", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "status": "CONFIRMED" }, "schema": { "additionalProperties": false, "description": "Describes the status of the personally identifiable information (PII) found in a parameter.", "properties": { "status": { "description": "Describes the status of the personally identifiable information (PII) found in a parameter. See [PII status](https://techdocs.akamai.com/api-definitions/reference/personally-identifiable-information-status).", "enum": [ "DISCOVERED", "CONFIRMED", "DEFERRED", "DECLINED" ], "example": "{{status}}", "type": "string", "x-akamai": { "file-path": "schemas/pii-status.yaml" } } }, "required": [ "status" ], "type": "object", "x-akamai": { "file-path": "schemas/pii-status-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "contentType": "json", "dateFirstSeen": "2021-12-16", "id": 1, "lastAction": null, "location": "body", "method": "GET", "newPii": true, "parameterId": 1, "parameterName": "email", "parameterPath": "/person/email", "resourceName": "Persons resource", "resourcePath": "/bookstore/persons", "response": false, "status": "DISCOVERED", "statusCodes": [], "type": "PERSONAL_EMAIL", "userCreated": false }, "schema": { "additionalProperties": false, "description": "Describes a personally identifiable information (PII) object.", "properties": { "contentType": { "description": "The content type of the payload in which PII exists. Supported values are `json`, `xml`, and `urlencoded`.", "enum": [ "json", "xml", "urlencoded" ], "type": "string" }, "dateFirstSeen": { "description": "The date when PII was added to an API endpoint definition either by you or the network.", "format": "date", "type": "string" }, "id": { "description": "The unique identifier for a PII object.", "type": "integer" }, "lastAction": { "additionalProperties": false, "description": "Describes the last action made by an end user.", "nullable": true, "properties": { "by": { "description": "The username of the person who made the change.", "type": "string" }, "date": { "description": "The ISO 8601 timestamp the action was taken.", "format": "date", "type": "string" } }, "type": "object" }, "location": { "description": "The payload location where the parameter with PII exists, the `path`, `header`, `cookie`, `query`, or `body`.", "enum": [ "path", "header", "cookie", "query", "body" ], "type": "string" }, "method": { "description": "The HTTP method for the call in which PII exists.", "type": "string" }, "newPii": { "description": "Whether the PII is new. The new PII found by the network has a status of `discovered` until any action changes it.", "type": "boolean" }, "parameterId": { "description": "Uniquely identifies parameters containing PII.", "nullable": true, "type": "integer" }, "parameterName": { "description": "The name of the parameter that contains PII.", "nullable": true, "type": "string" }, "parameterPath": { "description": "The parameter path where the PII exists, with segments delimited by `/`.", "type": "string" }, "resourceName": { "description": "The name of the resource in which PII exists.", "nullable": true, "type": "string" }, "resourcePath": { "description": "The URL path in which PII exists.", "type": "string" }, "response": { "description": "Whether the PII is registered in the response. When `false`, the parameter is in the request.", "type": "boolean" }, "status": { "description": "Describes the status of the personally identifiable information (PII) found in a parameter. See [PII status](https://techdocs.akamai.com/api-definitions/reference/personally-identifiable-information-status).", "enum": [ "DISCOVERED", "CONFIRMED", "DEFERRED", "DECLINED" ], "type": "string", "x-akamai": { "file-path": "schemas/pii-status.yaml" } }, "statusCodes": { "description": "Status codes for which PII exists. If the response contains PII, it lists the possible response codes. For a request the array is empty.", "items": { "type": "integer" }, "type": "array" }, "type": { "description": "Classifies PII as either `PERSONAL_EMAIL` or `CREDIT_OR_DEBIT_CARD_NUMBER`.", "enum": [ "PERSONAL_EMAIL", "CREDIT_OR_DEBIT_CARD_NUMBER" ], "type": "string", "x-akamai": { "file-path": "schemas/pii-type.yaml" } }, "userCreated": { "description": "When `true`, you defined PII using the API or Control Center. When `false`, the PII is discovered by the network.", "type": "boolean" } }, "required": [ "type", "parameterId" ], "type": "object", "x-akamai": { "file-path": "schemas/pii-dto.yaml" } } } }, "description": "Successfully updated the PII status." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to update PII status.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "Patch PII status per endpoint version", "tags": [ "Personally identifiable information" ] }, "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/api-end-point-id-path.yaml" } }, { "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/version-number-path.yaml" } }, { "description": "The unique identifier for the PII object.", "example": "{{piiId}}", "in": "path", "name": "piiId", "required": true, "schema": { "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/pii-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/pii-status.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/piis/{piiId}/status" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/resources": { "post": { "description": "Creates a resource in an endpoint version. The resource's full URL (concatenated hostname, `basePath`, and `resourcepath`) needs to be unique within the account. You can only create resources for versions that have never been activated on the staging or production network.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/post-resource" }, "operationId": "post-resource", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "apiResourceMethods": [ { "apiParameters": [ { "apiParameterLocation": "path", "apiParameterName": "magazineId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "array": false } ], "apiResourceMethod": "GET" } ], "apiResourceName": "magazine", "description": "A magazine item within the bookstore API.", "resourcePath": "/magazine/{magazineId}" }, "schema": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `json/xml`, or `urlencoded`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "json/xml", "urlencoded" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-request.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-request.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-request.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "apiResourceClonedFromId": null, "apiResourceId": 2935139, "apiResourceLogicId": 126269, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 588309, "apiParameterId": 1223250, "apiParameterLocation": "path", "apiParameterName": "magazineId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 500315, "array": false, "pathParamLocationId": null } ], "apiResourceMethod": "GET", "apiResourceMethodId": 365559, "apiResourceMethodLogicId": 205820 } ], "apiResourceName": "magazine", "createDate": "2019-06-17T08:26:59+0000", "createdBy": "bookstore_admin", "description": "A magazine item within the bookstore API.", "link": null, "lockVersion": 0, "private": false, "resourcePath": "/magazine/{magazineId}", "updateDate": "2019-06-17T08:26:59+0000", "updatedBy": "bookstore_admin" }, "schema": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } } } }, "description": "Saved API Endpoint Resource data.", "headers": { "Location": { "description": "Relative URL for created API resource.", "schema": { "type": "string" } } } } }, "summary": "Create a resource", "tags": [ "Resources" ] }, "get": { "description": "Lists all resources assigned to an endpoint version. You can use the `apiResourceId` of each returned resource to modify resources individually through the [Edit a resource](https://techdocs.akamai.com/api-definitions/reference/put-version-resource) operation, or run the [Edit a version](https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version) operation to batch-modify a group of resources.", "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-resources" }, "operationId": "get-endpoint-version-resources", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "apiResourceClonedFromId": null, "apiResourceId": 2926712, "apiResourceLogicId": 118435, "apiResourceMethodNameLists": [ "POST", "GET" ], "apiResourceName": "book", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "A book item within the bookstore API.", "link": "/api-definitions/v1/endpoints/574127/resources", "lockVersion": 0, "private": false, "resourcePath": "/book/{bookId}", "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin" }, { "apiResourceClonedFromId": null, "apiResourceId": 2935128, "apiResourceLogicId": 126224, "apiResourceMethodNameLists": [ "POST", "GET", "PUT" ], "apiResourceName": "user", "createDate": "2019-06-17T08:17:23+0000", "createdBy": "bookstore_admin", "description": "A registered bookstore user.", "link": "/api-definitions/v1/endpoints/574127/resources", "lockVersion": 0, "private": false, "resourcePath": "/user/{userId}", "updateDate": "2019-06-17T08:17:23+0000", "updatedBy": "bookstore_admin" }, { "apiResourceClonedFromId": null, "apiResourceId": 2935139, "apiResourceLogicId": 126269, "apiResourceMethodNameLists": [ "GET" ], "apiResourceName": "magazine", "createDate": "2019-06-17T08:26:59+0000", "createdBy": "bookstore_admin", "description": "A magazine item within the bookstore API.", "link": "/api-definitions/v1/endpoints/574127/resources", "lockVersion": 0, "private": false, "resourcePath": "/magazine/{magazineId}", "updateDate": "2019-06-17T08:26:59+0000", "updatedBy": "bookstore_admin" } ], "schema": { "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } }, "type": "array" } } }, "description": "The response lists API endpoint resources you have access to." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "List resources", "tags": [ "Resources" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/resources.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/resources" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/resources-detail": { "get": { "description": "Returns an endpoint version. Use this operation's response object when modifying an endpoint version through [Edit a version](https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version). Don't use [Get a version summary](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version) for the [Edit a version](https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version) operation.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-version-details" }, "operationId": "get-version-details", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "akamaiSecurityRestrictions": null, "apiCategoryIds": [ 2, 7 ], "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": 492375, "apiEndPointLocked": false, "apiEndPointName": "Bookstore API", "apiEndPointScheme": "http/https", "apiGatewayEnabled": true, "apiResources": [ { "apiResourceClonedFromId": null, "apiResourceId": 2926712, "apiResourceLogicId": 118435, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578116, "apiParameterId": 1212945, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 494448, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "GET", "apiResourceMethodId": 341591, "apiResourceMethodLogicId": 184404 }, { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578117, "apiParameterId": 1212946, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": { "arrayRestriction": null, "lengthRestriction": { "lengthMax": 15, "lengthMin": 3 }, "numberRangeRestriction": null, "rangeRestriction": null, "xmlConversionRule": null }, "apiParameterType": "string", "apiResourceMethParamId": 494449, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 341592, "apiResourceMethodLogicId": 184405 } ], "apiResourceName": "books", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "A book item within the bookstore API.", "link": null, "lockVersion": 2, "private": false, "resourcePath": "/books/{bookId}", "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin" } ], "availableActions": [ "DELETE", "CLONE_ENDPOINT", "ACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING" ], "basePath": "/bookstore", "caseSensitive": true, "clonedFromVersion": 1, "consumeType": "any", "contractId": "C-0N7RAC71", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "endpointHidden": false, "groupId": 12345, "isGraphQL": false, "lockVersion": 2, "positiveConstrainsEnabled": null, "productionStatus": null, "productionVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "protectedByApiKey": true, "responseConstraintsEnabled": false, "securityScheme": { "securitySchemeDetail": { "apiKeyLocation": "header", "apiKeyName": "apikey" }, "securitySchemeType": "apikey" }, "source": null, "stagingStatus": null, "stagingVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin", "versionHidden": false, "versionNumber": 1 }, "schema": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in cookies. These booleans override fields in the Method object. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the field is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__Read-only__ Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__Read-only__ The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__Read-only__ Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__Read-only__ The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__Read-only__ Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An endpoint and its associated resources.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-response.yaml" } } } }, "description": "Operation succeeded." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to retrieve API endpoint list.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "Get a version", "tags": [ "Resources" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/resources-detail.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/resources-detail" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/resources/{apiResourceId}": { "get": { "description": "Returns a resource within an endpoint version.", "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-resource" }, "operationId": "get-endpoint-version-resource", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "apiResourceClonedFromId": null, "apiResourceId": 2935139, "apiResourceLogicId": 126269, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 588309, "apiParameterId": 1223250, "apiParameterLocation": "path", "apiParameterName": "magazineId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 500315, "array": false, "pathParamLocationId": null } ], "apiResourceMethod": "GET", "apiResourceMethodId": 365559, "apiResourceMethodLogicId": 205820 } ], "apiResourceName": "magazine", "createDate": "2019-06-17T08:26:59+0000", "createdBy": "bookstore_admin", "description": "A magazine item within the bookstore API.", "link": null, "lockVersion": 0, "private": false, "resourcePath": "/magazine/{magazineId}", "updateDate": "2019-06-17T08:26:59+0000", "updatedBy": "bookstore_admin" }, "schema": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } } } }, "description": "API Endpoint Resource details defined by API Endpoint ID and API Resource ID." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The required resource doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } } }, "summary": "Get a resource", "tags": [ "Resources" ] }, "put": { "description": "Updates a resource within an endpoint version. You can edit information about a resource, the methods, and the parameters assigned to a resource. You can only modify resources assigned to versions that have never been activated on the staging or production network.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/put-version-resource" }, "operationId": "put-version-resource", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "apiResourceClonedFromId": null, "apiResourceId": 2935139, "apiResourceLogicId": 126269, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 588309, "apiParameterId": 1223250, "apiParameterLocation": "path", "apiParameterName": "magazineId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 500315, "array": false, "pathParamLocationId": null } ], "apiResourceMethod": "GET", "apiResourceMethodId": 365559, "apiResourceMethodLogicId": 205820 } ], "apiResourceName": "magazine", "createDate": "2019-06-17T08:26:59+0000", "createdBy": "bookstore_admin", "description": "A magazine item within the bookstore API.", "link": null, "lockVersion": 0, "private": false, "resourcePath": "/magazine/{magazineId}", "updateDate": "2019-06-17T08:26:59+0000", "updatedBy": "bookstore_admin" }, "schema": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `json/xml`, or `urlencoded`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "json/xml", "urlencoded" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-request.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-request.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "apiResourceClonedFromId": null, "apiResourceId": 2935139, "apiResourceLogicId": 126269, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 588309, "apiParameterId": 1223250, "apiParameterLocation": "path", "apiParameterName": "magazineId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 500315, "array": false, "pathParamLocationId": null } ], "apiResourceMethod": "GET", "apiResourceMethodId": 365559, "apiResourceMethodLogicId": 205820 } ], "apiResourceName": "magazine", "createDate": "2019-06-17T08:26:59+0000", "createdBy": "bookstore_admin", "description": "A magazine item within the bookstore API.", "link": null, "lockVersion": 0, "private": false, "resourcePath": "/magazine/{magazineId}", "updateDate": "2019-06-17T08:26:59+0000", "updatedBy": "bookstore_admin" }, "schema": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } } } }, "description": "Updated API Endpoint Resource Details." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of the request input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The required resource doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "detail": "Conflict with current state of resource.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 409, "title": "Conflict", "type": "/api-definitions/error-types/conflict" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/api-definitions/reference/409). After you get the data, you modify the API endpoint resource. You have to retrieve the updated data before update.", "x-akamai": { "file-path": "errors/409.yaml" } } }, "summary": "Edit a resource", "tags": [ "Resources" ] }, "delete": { "description": "Removes a resource from an endpoint version. You can only remove resources assigned to versions that have never been activated on the staging or production network.", "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-resource" }, "operationId": "delete-endpoint-version-resource", "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" } } ], "responses": { "204": { "content": {}, "description": "Resource successfully deleted." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have access to the endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The API endpoint or resource doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } } }, "summary": "Delete a resource", "tags": [ "Resources" ] }, "parameters": [ { "description": "The unique identifier for the resource.", "example": "{{apiResourceId}}", "in": "path", "name": "apiResourceId", "required": true, "schema": { "example": 4141850, "type": "integer" }, "x-akamai": { "file-path": "parameters/api-resource-id-path.yaml" } }, { "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/api-resource.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/resources/{apiResourceId}" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/api-privacy": { "get": { "description": "Returns the API privacy settings configured for an endpoint version and its assigned resources.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-api-privacy-settings" }, "operationId": "get-api-privacy-settings", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "public": false, "resources": { "10053577": { "inheritsFromEndpoint": false, "methods": {}, "notes": "resource 1 = users", "path": "/users", "public": false }, "10053578": { "inheritsFromEndpoint": false, "methods": { "PUT": { "inheritsFromEndpoint": false, "public": false } }, "notes": "resource 2 = items", "path": "/items", "public": true } } }, "schema": { "additionalProperties": false, "description": "API privacy settings configured for an endpoint and its associated resources. You can configure API privacy settings if the API Gateway product is in your contract.", "properties": { "public": { "description": "Whether the endpoint is public, that is, accessible without an API key.", "type": "boolean" }, "resources": { "additionalProperties": { "additionalProperties": false, "description": "Specifies a resource's privacy settings. This object's keys are resource IDs, and values are the resource's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the resource inherits the API privacy settings from the parent level.", "readOnly": true, "type": "boolean" }, "methods": { "additionalProperties": false, "description": "The methods assigned to the resource, either `POST`, `GET`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, or `PATCH`.", "properties": { "DELETE": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "GET": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "HEAD": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "OPTIONS": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "PATCH": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "POST": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "PUT": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } } }, "type": "object" }, "notes": { "description": "__Read-only__ The notes describing the purpose of the resource.", "minLength": 0, "readOnly": true, "type": "string" }, "path": { "description": "__Read-only__ The URL path relative to the hostnames on which the resource resides.", "minLength": 1, "readOnly": true, "type": "string" }, "public": { "description": "Whether the resource is public, that is, accessible without an API key.", "type": "boolean" } }, "required": [ "public" ], "title": "Resource privacy settings", "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-resource-id.yaml" } }, "description": "Specifies each resource's privacy settings. This object is a map of resource IDs to API privacy settings. Applies only when `public` is set to `false`.", "type": "object" } }, "required": [ "public" ], "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-dto.yaml" } } } }, "description": "Operation succeeded." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Get API privacy settings", "tags": [ "API privacy" ] }, "put": { "description": "Updates the API privacy settings configured for an endpoint version and its assigned resources.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/put-api-privacy-settings" }, "operationId": "put-api-privacy-settings", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "public": false, "resources": { "2926712": { "methods": { "GET": { "public": false }, "POST": { "public": false } }, "public": false } } }, "schema": { "additionalProperties": false, "description": "API privacy settings configured for an endpoint and its associated resources. You can configure API privacy settings if the API Gateway product is in your contract.", "properties": { "public": { "description": "Whether the endpoint is public, that is, accessible without an API key.", "example": "{{public}}", "type": "boolean" }, "resources": { "additionalProperties": { "additionalProperties": false, "description": "Specifies a resource's privacy settings. This object's keys are resource IDs, and values are the resource's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the resource inherits the API privacy settings from the parent level.", "readOnly": true, "type": "boolean" }, "methods": { "additionalProperties": false, "description": "The methods assigned to the resource, either `POST`, `GET`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, or `PATCH`.", "properties": { "DELETE": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "GET": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "HEAD": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "OPTIONS": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "PATCH": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "POST": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "PUT": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } } }, "type": "object" }, "notes": { "description": "__Read-only__ The notes describing the purpose of the resource.", "minLength": 0, "readOnly": true, "type": "string" }, "path": { "description": "__Read-only__ The URL path relative to the hostnames on which the resource resides.", "minLength": 1, "readOnly": true, "type": "string" }, "public": { "description": "Whether the resource is public, that is, accessible without an API key.", "type": "boolean" } }, "required": [ "public" ], "title": "Resource privacy settings", "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-resource-id.yaml" } }, "description": "Specifies each resource's privacy settings. This object is a map of resource IDs to API privacy settings. Applies only when `public` is set to `false`.", "type": "object" } }, "required": [ "public" ], "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "public": false, "resources": { "10053577": { "inheritsFromEndpoint": false, "methods": {}, "notes": "resource 1 = users", "path": "/users", "public": false }, "10053578": { "inheritsFromEndpoint": false, "methods": { "PUT": { "inheritsFromEndpoint": false, "public": false } }, "notes": "resource 2 = items", "path": "/items", "public": true } } }, "schema": { "additionalProperties": false, "description": "API privacy settings configured for an endpoint and its associated resources. You can configure API privacy settings if the API Gateway product is in your contract.", "properties": { "public": { "description": "Whether the endpoint is public, that is, accessible without an API key.", "type": "boolean" }, "resources": { "additionalProperties": { "additionalProperties": false, "description": "Specifies a resource's privacy settings. This object's keys are resource IDs, and values are the resource's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the resource inherits the API privacy settings from the parent level.", "readOnly": true, "type": "boolean" }, "methods": { "additionalProperties": false, "description": "The methods assigned to the resource, either `POST`, `GET`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, or `PATCH`.", "properties": { "DELETE": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "GET": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "HEAD": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "OPTIONS": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "PATCH": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "POST": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } }, "PUT": { "additionalProperties": false, "description": "A method's privacy settings.", "properties": { "inheritsFromEndpoint": { "description": "__Read-only__ Whether the method inherits the resource's API privacy settings.", "readOnly": true, "type": "boolean" }, "public": { "description": "Whether the method is public, that is, accessible without an API key.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-method.yaml" } } }, "type": "object" }, "notes": { "description": "__Read-only__ The notes describing the purpose of the resource.", "minLength": 0, "readOnly": true, "type": "string" }, "path": { "description": "__Read-only__ The URL path relative to the hostnames on which the resource resides.", "minLength": 1, "readOnly": true, "type": "string" }, "public": { "description": "Whether the resource is public, that is, accessible without an API key.", "type": "boolean" } }, "required": [ "public" ], "title": "Resource privacy settings", "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-resource-id.yaml" } }, "description": "Specifies each resource's privacy settings. This object is a map of resource IDs to API privacy settings. Applies only when `public` is set to `false`.", "type": "object" } }, "required": [ "public" ], "type": "object", "x-akamai": { "file-path": "schemas/api-privacy-settings-dto.yaml" } } } }, "description": "The response shows updated privacy settings." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Edit API privacy settings", "tags": [ "API privacy" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/api-privacy.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/api-privacy" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/cache": { "get": { "description": "Returns the caching settings configured for an endpoint version and its assigned resources. You can set all objects independently from the root `customize` field.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-cache-settings" }, "operationId": "get-cache-settings", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "cacheKey": { "customize": true, "exactMatch": true, "option": "INCLUDE_ALL_PRESERVE_ORDER", "parameters": null }, "customize": true, "downstreamCaching": { "customize": true, "headers": "CACHE_CONTROL_AND_EXPIRES", "lifetime": "SMALLER_VALUE", "markAsPrivate": false, "maxAge": null, "option": "ALLOW_CACHING" }, "enabled": true, "errorCaching": { "customize": true, "enabled": true, "maxAge": { "duration": 80, "unit": "SECONDS" }, "preserveStale": true }, "maxAge": { "duration": 100, "unit": "SECONDS" }, "option": "CACHE", "preRefreshing": { "enabled": true, "value": 40 }, "resources": { "2926712": { "cacheKey": { "customize": true, "exactMatch": true, "option": "INCLUDE_ALL_PRESERVE_ORDER", "parameters": null }, "inheritsFromEndpoint": true, "maxAge": { "duration": 100, "unit": "SECONDS" }, "methods": [ "POST", "GET" ], "option": "CACHE", "path": "/book/{bookId}", "preRefreshing": null, "serveStale": true }, "2935128": { "cacheKey": { "customize": false, "exactMatch": true, "option": "INCLUDE_ALL_PRESERVE_ORDER", "parameters": null }, "inheritsFromEndpoint": false, "maxAge": { "duration": 120, "unit": "SECONDS" }, "methods": [ "POST", "GET", "PUT" ], "option": "CACHE", "path": "/user/{userId}", "preRefreshing": null, "serveStale": false }, "2935139": { "cacheKey": { "customize": true, "exactMatch": true, "option": "INCLUDE_ALL_PRESERVE_ORDER", "parameters": null }, "inheritsFromEndpoint": true, "maxAge": { "duration": 100, "unit": "SECONDS" }, "methods": [ "GET" ], "option": "CACHE", "path": "/magazine/{magazineId}", "preRefreshing": { "enabled": true, "value": 40 }, "serveStale": true } }, "serveStale": true }, "schema": { "additionalProperties": false, "description": "Caching settings configured for an endpoint. Caching settings specify properties such as the maximum age of cached content, caching HTTP error responses, downstream cacheability, and cache key customization. You can set specific caching instructions for each resource within an endpoint version. You can configure caching settings if the API Gateway product is in your contract.", "properties": { "cacheKey": { "additionalProperties": false, "description": "The cache key settings configured for an endpoint or resource.", "properties": { "customize": { "description": "Whether you want to customize cache key settings for an endpoint. You can set this independently from the root `customize` field.", "type": "boolean" }, "exactMatch": { "description": "Whether the query parameters in the requests match exactly the string items in the corresponding `parameters`. When `false`, substrings match the start of the string. Relevant only if you set the corresponding `option` to either `INCLUDE` or `IGNORE`.", "nullable": true, "type": "boolean" }, "option": { "description": "The configuration option to customize cache keys. You can `INCLUDE` only the specified set of `parameters` in the cache key, or set `IGNORE` to exclude them. `IGNORE_ALL` excludes all parameters from the cache key. Set `INCLUDE_ALL_PRESERVE_ORDER` to key on the full set of parameters in the request's order, or `INCLUDE_ALL_ALPHABETIZE_ORDER` to ignore the original order.", "enum": [ "INCLUDE", "IGNORE", "IGNORE_ALL", "INCLUDE_ALL_PRESERVE_ORDER", "INCLUDE_ALL_ALPHABETIZE_ORDER" ], "nullable": true, "type": "string" }, "parameters": { "description": "Parameters to include in or exclude from cache keys, depending on the `option` you selected. This is only relevant if you set the corresponding `option` to either `INCLUDE` or `IGNORE`.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "nullable": true, "type": "array" } }, "required": [ "customize" ], "type": "object", "x-akamai": { "file-path": "schemas/cache-key-dto.yaml" } }, "customize": { "description": "Whether you want to customize caching behavior for the endpoint. This applies only to the main caching settings. You can set `customize` fields for `errorCaching`, `cacheKey` and `downstreamCaching` independently.", "type": "boolean" }, "downstreamCaching": { "additionalProperties": false, "description": "Downstream caching settings. Downstream caching refers to the caching instructions assigned to objects sent with responses toward clients, for example browsers, mobile devices, or client proxies.", "properties": { "customize": { "description": "Whether you want to customize downstream caching behavior for the endpoint. You can set this independently from the root `customize` field.", "type": "boolean" }, "headers": { "description": "The policy for sending headers downstream, either `CACHE_CONTROL_AND_EXPIRES` to send both `Cache-Control` and `Expires` headers, `CACHE_CONTROL` to send only the `Cache-Control` header, `EXPIRES` to send only the `Expires` header, or `SAME_AS_ORIGIN` to send the same headers as your origin.", "enum": [ "CACHE_CONTROL_AND_EXPIRES", "CACHE_CONTROL", "EXPIRES", "SAME_AS_ORIGIN" ], "type": "string" }, "lifetime": { "default": "SMALLER_VALUE", "description": "The cache lifetime policy, either `SMALLER_VALUE` for a value smaller than specified in the origin header or the remaining edge TTL, `GREATER_VALUE` for a value greater than specified in the origin header or the remaining edge TTL, `REMAINING_EDGE_TTL` for a remaining edge TTL, `FULL_EDGE_TTL` for a full edge TTL, `FIXED_VALUE` for a value that you specify, or `CALCULATES_EXPIRES_FROM_ORIGIN_CACHE_CONTROL` for calculating the maximum age from the origin `Cache-Control` header.", "enum": [ "SMALLER_VALUE", "GREATER_VALUE", "REMAINING_EDGE_TTL", "FULL_EDGE_TTL", "FIXED_VALUE", "CALCULATES_EXPIRES_FROM_ORIGIN_CACHE_CONTROL" ], "type": "string" }, "markAsPrivate": { "default": false, "description": "Specifies whether to disallow storing responses in a shared cache. Use this when you want to set a maximum age for the end client, but have shared caches not store the response.", "type": "boolean" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration to keep content in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "option": { "default": "ALLOW_CACHING", "description": "The option for downstream caching, either `ALLOW_CACHING` to allow downstream caching, `ALLOW_CACHING_REQUIRES_REVALIDATION` to allow downstream caching, but require origin revalidation, `NOT_ALLOW_CACHING` to disallow downstream caching, `PASS_CACHEABILITY_HEADERS_FROM_ORIGIN` to pass cacheability headers from your origin, or `DO_NOT_SEND_HEADERS` to disallow sending headers and apply browser defaults.", "enum": [ "ALLOW_CACHING", "ALLOW_CACHING_REQUIRES_REVALIDATION", "NOT_ALLOW_CACHING", "PASS_CACHEABILITY_HEADERS_FROM_ORIGIN", "DO_NOT_SEND_HEADERS" ], "type": "string" } }, "required": [ "customize" ], "type": "object" }, "enabled": { "deprecated": true, "description": "__Deprecated__ Delivery caching settings for the endpoint can be overridden by using four independent `customize` fields.", "type": "boolean", "x-akamai": { "status": "DEPRECATED" } }, "errorCaching": { "additionalProperties": false, "description": "Error caching settings.", "properties": { "customize": { "description": "Whether you want to customize error caching behavior for the endpoint. You can set this independently from the root `customize` field.", "type": "boolean" }, "enabled": { "description": "Defines how you want to cache error responses. A `true` value caches HTTP error responses according to the `maxAge` setting. A `false` value disables caching of HTTP error responses.", "type": "boolean" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration to keep content in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "preserveStale": { "default": false, "description": "Whether to preserve stale responses when the origin is unreachable and content revalidation isn't possible.", "type": "boolean" } }, "required": [ "customize" ], "type": "object" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration to keep content in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "option": { "default": "CACHE", "description": "The options for how to pass cached content, either `CACHE` to enable caching in Akamai platform servers according to the instructions you specify, `BYPASS_CACHE` to disallow caching in Akamai platform servers and keep the existing cache entries, `NO_STORE` to disallow caching in Akamai platform servers and remove the existing cache entries, `HONOR_ORIGIN_CACHE_CONTROL` to apply caching instructions specified in your origin's `Cache-Control` header, `HONOR_ORIGIN_EXPIRES` to apply caching instructions specified in your origin's `Expires` header, or `HONOR_ORIGIN_CACHE_CONTROL_AND_EXPIRES` to apply caching instructions specified in your origin's `Cache-Control` and `Expires` headers.", "enum": [ "CACHE", "BYPASS_CACHE", "NO_STORE", "HONOR_ORIGIN_CACHE_CONTROL", "HONOR_ORIGIN_EXPIRES", "HONOR_ORIGIN_CACHE_CONTROL_AND_EXPIRES" ], "type": "string" }, "preRefreshing": { "additionalProperties": false, "description": "Cache prefreshing settings. When enabled, edge servers asynchronously refresh cached objects after a specified percentage of the object's TTL elapses.", "nullable": true, "properties": { "enabled": { "description": "Whether you enable cache prefreshing.", "type": "boolean" }, "value": { "description": "With TTL the duration before cached content ordinarily refreshes, this refreshes content before then, expressed as a percentage of the TTL, from 0 to 99.", "maximum": 99, "minimum": 0, "type": "integer" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/pre-refreshing.yaml" } }, "resources": { "additionalProperties": { "additionalProperties": false, "description": "Caching settings for each resource.", "properties": { "cacheKey": { "additionalProperties": false, "description": "Cache key settings.", "properties": { "customize": { "description": "Whether you want to customize cache key settings for an endpoint. You can set this independently from the root `customize` field.", "type": "boolean" }, "exactMatch": { "description": "Whether the query parameters in the requests match exactly the string items in the corresponding `parameters`. When `false`, substrings match the start of the string. Relevant only if you set the corresponding `option` to either `INCLUDE` or `IGNORE`.", "nullable": true, "type": "boolean" }, "option": { "description": "The configuration option to customize cache keys. You can `INCLUDE` only the specified set of `parameters` in the cache key, or set `IGNORE` to exclude them. `IGNORE_ALL` excludes all parameters from the cache key. Set `INCLUDE_ALL_PRESERVE_ORDER` to key on the full set of parameters in the request's order, or `INCLUDE_ALL_ALPHABETIZE_ORDER` to ignore the original order.", "enum": [ "INCLUDE", "IGNORE", "IGNORE_ALL", "INCLUDE_ALL_PRESERVE_ORDER", "INCLUDE_ALL_ALPHABETIZE_ORDER" ], "nullable": true, "type": "string" }, "parameters": { "description": "Parameters to include in or exclude from cache keys, depending on the `option` you selected. This is only relevant if you set the corresponding `option` to either `INCLUDE` or `IGNORE`.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "nullable": true, "type": "array" } }, "required": [ "customize" ], "type": "object", "x-akamai": { "file-path": "schemas/cache-key-dto.yaml" } }, "inheritsFromEndpoint": { "description": "Whether the resource inherits the top-level API caching settings.", "type": "boolean" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration of keeping content in a cache. If set, overwrites the max age instructions set at the endpoint level.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "methods": { "description": "__Read-only__ The methods assigned to the resource, either `POST`, `GET`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, or `PATCH`.", "items": { "enum": [ "HEAD", "DELETE", "POST", "GET", "OPTIONS", "PUT", "PATCH" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "option": { "default": "CACHE", "description": "The resource caching option, either `CACHE` to enable caching in Akamai platform servers according to the instructions you specify, `BYPASS_CACHE` to send requests straight to origin and disallow caching in downstream caches, `NO_STORE` to disallow caching in Akamai platform servers, `HONOR_ORIGIN_CACHE_CONTROL` to apply caching instructions specified in your origin's `Cache-Control` header, `HONOR_ORIGIN_EXPIRES` to apply caching instructions specified in your origin's `Expires` header, or `HONOR_ORIGIN_CACHE_CONTROL_AND_EXPIRES` to apply caching instructions specified in your origin's `Cache-Control` and `Expires` headers. If set, overwrites the caching instructions set at the endpoint level.", "enum": [ "CACHE", "BYPASS_CACHE", "NO_STORE", "HONOR_ORIGIN_CACHE_CONTROL", "HONOR_ORIGIN_EXPIRES", "HONOR_ORIGIN_CACHE_CONTROL_AND_EXPIRES" ], "type": "string" }, "path": { "description": "__Read-only__ The URL path relative to the hostnames on which the resource resides.", "minLength": 1, "readOnly": true, "type": "string" }, "preRefreshing": { "additionalProperties": false, "description": "Cache prefreshing settings. When enabled, edge servers asynchronously refresh cached objects after a specified percentage of the object's TTL elapses.", "nullable": true, "properties": { "enabled": { "description": "Whether you enable cache prefreshing.", "type": "boolean" }, "value": { "description": "With TTL the duration before cached content ordinarily refreshes, this refreshes content before then, expressed as a percentage of the TTL, from 0 to 99.", "maximum": 99, "minimum": 0, "type": "integer" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/pre-refreshing.yaml" } }, "serveStale": { "description": "Whether to serve stale objects when the origin is unreachable and content revalidation isn't possible.", "type": "boolean" } }, "required": [ "path", "methods", "option", "maxAge", "serveStale", "cacheKey", "preRefreshing", "inheritsFromEndpoint" ], "title": "Resource's caching settings", "type": "object", "x-akamai": { "file-path": "schemas/resources-cache.yaml" } }, "description": "Caching settings for each resource assigned to an endpoint version. This object is a map where the keys are resource IDs and values are cache settings applied to them.", "type": "object" }, "serveStale": { "description": "Whether to serve stale responses when the origin is unreachable and content revalidation isn't possible.", "type": "boolean" } }, "required": [ "customize", "downstreamCaching", "errorCaching", "cacheKey" ], "type": "object", "x-akamai": { "file-path": "schemas/cache-settings-dto.yaml" } } } }, "description": "Response data shows current cache settings." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Get cache settings", "tags": [ "Cache" ] }, "put": { "description": "Updates the caching settings configured for an endpoint version and its assigned resources.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/put-cache-settings" }, "operationId": "put-cache-settings", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "cacheKey": { "customize": true, "exactMatch": true, "option": "INCLUDE_ALL_PRESERVE_ORDER", "parameters": null }, "customize": true, "downstreamCaching": { "customize": true, "headers": "CACHE_CONTROL_AND_EXPIRES", "lifetime": "SMALLER_VALUE", "markAsPrivate": false, "maxAge": null, "option": "ALLOW_CACHING" }, "enabled": true, "errorCaching": { "customize": true, "enabled": true, "maxAge": { "duration": 80, "unit": "SECONDS" }, "preserveStale": true }, "maxAge": { "duration": 100, "unit": "SECONDS" }, "option": "CACHE", "preRefreshing": { "enabled": true, "value": 40 }, "resources": { "2926712": { "cacheKey": { "customize": true, "exactMatch": true, "option": "INCLUDE_ALL_PRESERVE_ORDER", "parameters": null }, "inheritsFromEndpoint": true, "maxAge": { "duration": 100, "unit": "SECONDS" }, "methods": [ "POST", "GET" ], "option": "CACHE", "path": "/book/{bookId}", "preRefreshing": null, "serveStale": true }, "2935128": { "cacheKey": { "customize": false, "exactMatch": true, "option": "INCLUDE_ALL_PRESERVE_ORDER", "parameters": null }, "inheritsFromEndpoint": false, "maxAge": { "duration": 120, "unit": "SECONDS" }, "methods": [ "POST", "GET", "PUT" ], "option": "CACHE", "path": "/user/{userId}", "preRefreshing": null, "serveStale": false }, "2935139": { "cacheKey": { "customize": true, "exactMatch": true, "option": "INCLUDE_ALL_PRESERVE_ORDER", "parameters": null }, "inheritsFromEndpoint": true, "maxAge": { "duration": 100, "unit": "SECONDS" }, "methods": [ "GET" ], "option": "CACHE", "path": "/magazine/{magazineId}", "preRefreshing": { "enabled": true, "value": 40 }, "serveStale": true } }, "serveStale": true }, "schema": { "additionalProperties": false, "description": "Caching settings configured for an endpoint. Caching settings specify properties such as the maximum age of cached content, caching HTTP error responses, downstream cacheability, and cache key customization. You can set specific caching instructions for each resource within an endpoint version. You can configure caching settings if the API Gateway product is in your contract.", "properties": { "cacheKey": { "additionalProperties": false, "description": "The cache key settings configured for an endpoint or resource.", "properties": { "customize": { "description": "Whether you want to customize cache key settings for an endpoint. You can set this independently from the root `customize` field.", "type": "boolean" }, "exactMatch": { "description": "Whether the query parameters in the requests match exactly the string items in the corresponding `parameters`. When `false`, substrings match the start of the string. Relevant only if you set the corresponding `option` to either `INCLUDE` or `IGNORE`.", "nullable": true, "type": "boolean" }, "option": { "description": "The configuration option to customize cache keys. You can `INCLUDE` only the specified set of `parameters` in the cache key, or set `IGNORE` to exclude them. `IGNORE_ALL` excludes all parameters from the cache key. Set `INCLUDE_ALL_PRESERVE_ORDER` to key on the full set of parameters in the request's order, or `INCLUDE_ALL_ALPHABETIZE_ORDER` to ignore the original order.", "enum": [ "INCLUDE", "IGNORE", "IGNORE_ALL", "INCLUDE_ALL_PRESERVE_ORDER", "INCLUDE_ALL_ALPHABETIZE_ORDER" ], "nullable": true, "type": "string" }, "parameters": { "description": "Parameters to include in or exclude from cache keys, depending on the `option` you selected. This is only relevant if you set the corresponding `option` to either `INCLUDE` or `IGNORE`.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "nullable": true, "type": "array" } }, "required": [ "customize" ], "type": "object", "x-akamai": { "file-path": "schemas/cache-key-dto.yaml" } }, "customize": { "description": "Whether you want to customize caching behavior for the endpoint. This applies only to the main caching settings. You can set `customize` fields for `errorCaching`, `cacheKey` and `downstreamCaching` independently.", "example": "{{customize}}", "type": "boolean" }, "downstreamCaching": { "additionalProperties": false, "description": "Downstream caching settings. Downstream caching refers to the caching instructions assigned to objects sent with responses toward clients, for example browsers, mobile devices, or client proxies.", "properties": { "customize": { "description": "Whether you want to customize downstream caching behavior for the endpoint. You can set this independently from the root `customize` field.", "type": "boolean" }, "headers": { "description": "The policy for sending headers downstream, either `CACHE_CONTROL_AND_EXPIRES` to send both `Cache-Control` and `Expires` headers, `CACHE_CONTROL` to send only the `Cache-Control` header, `EXPIRES` to send only the `Expires` header, or `SAME_AS_ORIGIN` to send the same headers as your origin.", "enum": [ "CACHE_CONTROL_AND_EXPIRES", "CACHE_CONTROL", "EXPIRES", "SAME_AS_ORIGIN" ], "type": "string" }, "lifetime": { "default": "SMALLER_VALUE", "description": "The cache lifetime policy, either `SMALLER_VALUE` for a value smaller than specified in the origin header or the remaining edge TTL, `GREATER_VALUE` for a value greater than specified in the origin header or the remaining edge TTL, `REMAINING_EDGE_TTL` for a remaining edge TTL, `FULL_EDGE_TTL` for a full edge TTL, `FIXED_VALUE` for a value that you specify, or `CALCULATES_EXPIRES_FROM_ORIGIN_CACHE_CONTROL` for calculating the maximum age from the origin `Cache-Control` header.", "enum": [ "SMALLER_VALUE", "GREATER_VALUE", "REMAINING_EDGE_TTL", "FULL_EDGE_TTL", "FIXED_VALUE", "CALCULATES_EXPIRES_FROM_ORIGIN_CACHE_CONTROL" ], "type": "string" }, "markAsPrivate": { "default": false, "description": "Specifies whether to disallow storing responses in a shared cache. Use this when you want to set a maximum age for the end client, but have shared caches not store the response.", "type": "boolean" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration to keep content in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "option": { "default": "ALLOW_CACHING", "description": "The option for downstream caching, either `ALLOW_CACHING` to allow downstream caching, `ALLOW_CACHING_REQUIRES_REVALIDATION` to allow downstream caching, but require origin revalidation, `NOT_ALLOW_CACHING` to disallow downstream caching, `PASS_CACHEABILITY_HEADERS_FROM_ORIGIN` to pass cacheability headers from your origin, or `DO_NOT_SEND_HEADERS` to disallow sending headers and apply browser defaults.", "enum": [ "ALLOW_CACHING", "ALLOW_CACHING_REQUIRES_REVALIDATION", "NOT_ALLOW_CACHING", "PASS_CACHEABILITY_HEADERS_FROM_ORIGIN", "DO_NOT_SEND_HEADERS" ], "type": "string" } }, "required": [ "customize" ], "type": "object" }, "enabled": { "deprecated": true, "description": "__Deprecated__ Delivery caching settings for the endpoint can be overridden by using four independent `customize` fields.", "example": "{{enabled}}", "type": "boolean", "x-akamai": { "status": "DEPRECATED" } }, "errorCaching": { "additionalProperties": false, "description": "Error caching settings.", "properties": { "customize": { "description": "Whether you want to customize error caching behavior for the endpoint. You can set this independently from the root `customize` field.", "type": "boolean" }, "enabled": { "description": "Defines how you want to cache error responses. A `true` value caches HTTP error responses according to the `maxAge` setting. A `false` value disables caching of HTTP error responses.", "type": "boolean" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration to keep content in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "preserveStale": { "default": false, "description": "Whether to preserve stale responses when the origin is unreachable and content revalidation isn't possible.", "type": "boolean" } }, "required": [ "customize" ], "type": "object" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration to keep content in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "option": { "default": "CACHE", "description": "The options for how to pass cached content, either `CACHE` to enable caching in Akamai platform servers according to the instructions you specify, `BYPASS_CACHE` to disallow caching in Akamai platform servers and keep the existing cache entries, `NO_STORE` to disallow caching in Akamai platform servers and remove the existing cache entries, `HONOR_ORIGIN_CACHE_CONTROL` to apply caching instructions specified in your origin's `Cache-Control` header, `HONOR_ORIGIN_EXPIRES` to apply caching instructions specified in your origin's `Expires` header, or `HONOR_ORIGIN_CACHE_CONTROL_AND_EXPIRES` to apply caching instructions specified in your origin's `Cache-Control` and `Expires` headers.", "enum": [ "CACHE", "BYPASS_CACHE", "NO_STORE", "HONOR_ORIGIN_CACHE_CONTROL", "HONOR_ORIGIN_EXPIRES", "HONOR_ORIGIN_CACHE_CONTROL_AND_EXPIRES" ], "example": "{{option}}", "type": "string" }, "preRefreshing": { "additionalProperties": false, "description": "Cache prefreshing settings. When enabled, edge servers asynchronously refresh cached objects after a specified percentage of the object's TTL elapses.", "nullable": true, "properties": { "enabled": { "description": "Whether you enable cache prefreshing.", "type": "boolean" }, "value": { "description": "With TTL the duration before cached content ordinarily refreshes, this refreshes content before then, expressed as a percentage of the TTL, from 0 to 99.", "maximum": 99, "minimum": 0, "type": "integer" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/pre-refreshing.yaml" } }, "resources": { "additionalProperties": { "additionalProperties": false, "description": "Caching settings for each resource.", "properties": { "cacheKey": { "additionalProperties": false, "description": "Cache key settings.", "properties": { "customize": { "description": "Whether you want to customize cache key settings for an endpoint. You can set this independently from the root `customize` field.", "type": "boolean" }, "exactMatch": { "description": "Whether the query parameters in the requests match exactly the string items in the corresponding `parameters`. When `false`, substrings match the start of the string. Relevant only if you set the corresponding `option` to either `INCLUDE` or `IGNORE`.", "nullable": true, "type": "boolean" }, "option": { "description": "The configuration option to customize cache keys. You can `INCLUDE` only the specified set of `parameters` in the cache key, or set `IGNORE` to exclude them. `IGNORE_ALL` excludes all parameters from the cache key. Set `INCLUDE_ALL_PRESERVE_ORDER` to key on the full set of parameters in the request's order, or `INCLUDE_ALL_ALPHABETIZE_ORDER` to ignore the original order.", "enum": [ "INCLUDE", "IGNORE", "IGNORE_ALL", "INCLUDE_ALL_PRESERVE_ORDER", "INCLUDE_ALL_ALPHABETIZE_ORDER" ], "nullable": true, "type": "string" }, "parameters": { "description": "Parameters to include in or exclude from cache keys, depending on the `option` you selected. This is only relevant if you set the corresponding `option` to either `INCLUDE` or `IGNORE`.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "nullable": true, "type": "array" } }, "required": [ "customize" ], "type": "object", "x-akamai": { "file-path": "schemas/cache-key-dto.yaml" } }, "inheritsFromEndpoint": { "description": "Whether the resource inherits the top-level API caching settings.", "type": "boolean" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration of keeping content in a cache. If set, overwrites the max age instructions set at the endpoint level.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "methods": { "description": "__Read-only__ The methods assigned to the resource, either `POST`, `GET`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, or `PATCH`.", "items": { "enum": [ "HEAD", "DELETE", "POST", "GET", "OPTIONS", "PUT", "PATCH" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "option": { "default": "CACHE", "description": "The resource caching option, either `CACHE` to enable caching in Akamai platform servers according to the instructions you specify, `BYPASS_CACHE` to send requests straight to origin and disallow caching in downstream caches, `NO_STORE` to disallow caching in Akamai platform servers, `HONOR_ORIGIN_CACHE_CONTROL` to apply caching instructions specified in your origin's `Cache-Control` header, `HONOR_ORIGIN_EXPIRES` to apply caching instructions specified in your origin's `Expires` header, or `HONOR_ORIGIN_CACHE_CONTROL_AND_EXPIRES` to apply caching instructions specified in your origin's `Cache-Control` and `Expires` headers. If set, overwrites the caching instructions set at the endpoint level.", "enum": [ "CACHE", "BYPASS_CACHE", "NO_STORE", "HONOR_ORIGIN_CACHE_CONTROL", "HONOR_ORIGIN_EXPIRES", "HONOR_ORIGIN_CACHE_CONTROL_AND_EXPIRES" ], "type": "string" }, "path": { "description": "__Read-only__ The URL path relative to the hostnames on which the resource resides.", "minLength": 1, "readOnly": true, "type": "string" }, "preRefreshing": { "additionalProperties": false, "description": "Cache prefreshing settings. When enabled, edge servers asynchronously refresh cached objects after a specified percentage of the object's TTL elapses.", "nullable": true, "properties": { "enabled": { "description": "Whether you enable cache prefreshing.", "type": "boolean" }, "value": { "description": "With TTL the duration before cached content ordinarily refreshes, this refreshes content before then, expressed as a percentage of the TTL, from 0 to 99.", "maximum": 99, "minimum": 0, "type": "integer" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/pre-refreshing.yaml" } }, "serveStale": { "description": "Whether to serve stale objects when the origin is unreachable and content revalidation isn't possible.", "type": "boolean" } }, "required": [ "path", "methods", "option", "maxAge", "serveStale", "cacheKey", "preRefreshing", "inheritsFromEndpoint" ], "title": "Resource's caching settings", "type": "object", "x-akamai": { "file-path": "schemas/resources-cache.yaml" } }, "description": "Caching settings for each resource assigned to an endpoint version. This object is a map where the keys are resource IDs and values are cache settings applied to them.", "type": "object" }, "serveStale": { "description": "Whether to serve stale responses when the origin is unreachable and content revalidation isn't possible.", "example": "{{serveStale}}", "type": "boolean" } }, "required": [ "customize", "downstreamCaching", "errorCaching", "cacheKey" ], "type": "object", "x-akamai": { "file-path": "schemas/cache-settings-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "cacheKey": { "customize": true, "exactMatch": true, "option": "INCLUDE_ALL_PRESERVE_ORDER", "parameters": null }, "customize": true, "downstreamCaching": { "customize": true, "headers": "CACHE_CONTROL_AND_EXPIRES", "lifetime": "SMALLER_VALUE", "markAsPrivate": false, "maxAge": null, "option": "ALLOW_CACHING" }, "enabled": true, "errorCaching": { "customize": true, "enabled": true, "maxAge": { "duration": 80, "unit": "SECONDS" }, "preserveStale": true }, "maxAge": { "duration": 100, "unit": "SECONDS" }, "option": "CACHE", "preRefreshing": { "enabled": true, "value": 40 }, "resources": { "2926712": { "cacheKey": { "customize": true, "exactMatch": true, "option": "INCLUDE_ALL_PRESERVE_ORDER", "parameters": null }, "inheritsFromEndpoint": true, "maxAge": { "duration": 100, "unit": "SECONDS" }, "methods": [ "POST", "GET" ], "option": "CACHE", "path": "/book/{bookId}", "preRefreshing": null, "serveStale": true }, "2935128": { "cacheKey": { "customize": false, "exactMatch": true, "option": "INCLUDE_ALL_PRESERVE_ORDER", "parameters": null }, "inheritsFromEndpoint": false, "maxAge": { "duration": 120, "unit": "SECONDS" }, "methods": [ "POST", "GET", "PUT" ], "option": "CACHE", "path": "/user/{userId}", "preRefreshing": null, "serveStale": false }, "2935139": { "cacheKey": { "customize": true, "exactMatch": true, "option": "INCLUDE_ALL_PRESERVE_ORDER", "parameters": null }, "inheritsFromEndpoint": true, "maxAge": { "duration": 100, "unit": "SECONDS" }, "methods": [ "GET" ], "option": "CACHE", "path": "/magazine/{magazineId}", "preRefreshing": { "enabled": true, "value": 40 }, "serveStale": true } }, "serveStale": true }, "schema": { "additionalProperties": false, "description": "Caching settings configured for an endpoint. Caching settings specify properties such as the maximum age of cached content, caching HTTP error responses, downstream cacheability, and cache key customization. You can set specific caching instructions for each resource within an endpoint version. You can configure caching settings if the API Gateway product is in your contract.", "properties": { "cacheKey": { "additionalProperties": false, "description": "The cache key settings configured for an endpoint or resource.", "properties": { "customize": { "description": "Whether you want to customize cache key settings for an endpoint. You can set this independently from the root `customize` field.", "type": "boolean" }, "exactMatch": { "description": "Whether the query parameters in the requests match exactly the string items in the corresponding `parameters`. When `false`, substrings match the start of the string. Relevant only if you set the corresponding `option` to either `INCLUDE` or `IGNORE`.", "nullable": true, "type": "boolean" }, "option": { "description": "The configuration option to customize cache keys. You can `INCLUDE` only the specified set of `parameters` in the cache key, or set `IGNORE` to exclude them. `IGNORE_ALL` excludes all parameters from the cache key. Set `INCLUDE_ALL_PRESERVE_ORDER` to key on the full set of parameters in the request's order, or `INCLUDE_ALL_ALPHABETIZE_ORDER` to ignore the original order.", "enum": [ "INCLUDE", "IGNORE", "IGNORE_ALL", "INCLUDE_ALL_PRESERVE_ORDER", "INCLUDE_ALL_ALPHABETIZE_ORDER" ], "nullable": true, "type": "string" }, "parameters": { "description": "Parameters to include in or exclude from cache keys, depending on the `option` you selected. This is only relevant if you set the corresponding `option` to either `INCLUDE` or `IGNORE`.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "nullable": true, "type": "array" } }, "required": [ "customize" ], "type": "object", "x-akamai": { "file-path": "schemas/cache-key-dto.yaml" } }, "customize": { "description": "Whether you want to customize caching behavior for the endpoint. This applies only to the main caching settings. You can set `customize` fields for `errorCaching`, `cacheKey` and `downstreamCaching` independently.", "type": "boolean" }, "downstreamCaching": { "additionalProperties": false, "description": "Downstream caching settings. Downstream caching refers to the caching instructions assigned to objects sent with responses toward clients, for example browsers, mobile devices, or client proxies.", "properties": { "customize": { "description": "Whether you want to customize downstream caching behavior for the endpoint. You can set this independently from the root `customize` field.", "type": "boolean" }, "headers": { "description": "The policy for sending headers downstream, either `CACHE_CONTROL_AND_EXPIRES` to send both `Cache-Control` and `Expires` headers, `CACHE_CONTROL` to send only the `Cache-Control` header, `EXPIRES` to send only the `Expires` header, or `SAME_AS_ORIGIN` to send the same headers as your origin.", "enum": [ "CACHE_CONTROL_AND_EXPIRES", "CACHE_CONTROL", "EXPIRES", "SAME_AS_ORIGIN" ], "type": "string" }, "lifetime": { "default": "SMALLER_VALUE", "description": "The cache lifetime policy, either `SMALLER_VALUE` for a value smaller than specified in the origin header or the remaining edge TTL, `GREATER_VALUE` for a value greater than specified in the origin header or the remaining edge TTL, `REMAINING_EDGE_TTL` for a remaining edge TTL, `FULL_EDGE_TTL` for a full edge TTL, `FIXED_VALUE` for a value that you specify, or `CALCULATES_EXPIRES_FROM_ORIGIN_CACHE_CONTROL` for calculating the maximum age from the origin `Cache-Control` header.", "enum": [ "SMALLER_VALUE", "GREATER_VALUE", "REMAINING_EDGE_TTL", "FULL_EDGE_TTL", "FIXED_VALUE", "CALCULATES_EXPIRES_FROM_ORIGIN_CACHE_CONTROL" ], "type": "string" }, "markAsPrivate": { "default": false, "description": "Specifies whether to disallow storing responses in a shared cache. Use this when you want to set a maximum age for the end client, but have shared caches not store the response.", "type": "boolean" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration to keep content in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "option": { "default": "ALLOW_CACHING", "description": "The option for downstream caching, either `ALLOW_CACHING` to allow downstream caching, `ALLOW_CACHING_REQUIRES_REVALIDATION` to allow downstream caching, but require origin revalidation, `NOT_ALLOW_CACHING` to disallow downstream caching, `PASS_CACHEABILITY_HEADERS_FROM_ORIGIN` to pass cacheability headers from your origin, or `DO_NOT_SEND_HEADERS` to disallow sending headers and apply browser defaults.", "enum": [ "ALLOW_CACHING", "ALLOW_CACHING_REQUIRES_REVALIDATION", "NOT_ALLOW_CACHING", "PASS_CACHEABILITY_HEADERS_FROM_ORIGIN", "DO_NOT_SEND_HEADERS" ], "type": "string" } }, "required": [ "customize" ], "type": "object" }, "enabled": { "deprecated": true, "description": "__Deprecated__ Delivery caching settings for the endpoint can be overridden by using four independent `customize` fields.", "type": "boolean", "x-akamai": { "status": "DEPRECATED" } }, "errorCaching": { "additionalProperties": false, "description": "Error caching settings.", "properties": { "customize": { "description": "Whether you want to customize error caching behavior for the endpoint. You can set this independently from the root `customize` field.", "type": "boolean" }, "enabled": { "description": "Defines how you want to cache error responses. A `true` value caches HTTP error responses according to the `maxAge` setting. A `false` value disables caching of HTTP error responses.", "type": "boolean" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration to keep content in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "preserveStale": { "default": false, "description": "Whether to preserve stale responses when the origin is unreachable and content revalidation isn't possible.", "type": "boolean" } }, "required": [ "customize" ], "type": "object" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration to keep content in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "option": { "default": "CACHE", "description": "The options for how to pass cached content, either `CACHE` to enable caching in Akamai platform servers according to the instructions you specify, `BYPASS_CACHE` to disallow caching in Akamai platform servers and keep the existing cache entries, `NO_STORE` to disallow caching in Akamai platform servers and remove the existing cache entries, `HONOR_ORIGIN_CACHE_CONTROL` to apply caching instructions specified in your origin's `Cache-Control` header, `HONOR_ORIGIN_EXPIRES` to apply caching instructions specified in your origin's `Expires` header, or `HONOR_ORIGIN_CACHE_CONTROL_AND_EXPIRES` to apply caching instructions specified in your origin's `Cache-Control` and `Expires` headers.", "enum": [ "CACHE", "BYPASS_CACHE", "NO_STORE", "HONOR_ORIGIN_CACHE_CONTROL", "HONOR_ORIGIN_EXPIRES", "HONOR_ORIGIN_CACHE_CONTROL_AND_EXPIRES" ], "type": "string" }, "preRefreshing": { "additionalProperties": false, "description": "Cache prefreshing settings. When enabled, edge servers asynchronously refresh cached objects after a specified percentage of the object's TTL elapses.", "nullable": true, "properties": { "enabled": { "description": "Whether you enable cache prefreshing.", "type": "boolean" }, "value": { "description": "With TTL the duration before cached content ordinarily refreshes, this refreshes content before then, expressed as a percentage of the TTL, from 0 to 99.", "maximum": 99, "minimum": 0, "type": "integer" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/pre-refreshing.yaml" } }, "resources": { "additionalProperties": { "additionalProperties": false, "description": "Caching settings for each resource.", "properties": { "cacheKey": { "additionalProperties": false, "description": "Cache key settings.", "properties": { "customize": { "description": "Whether you want to customize cache key settings for an endpoint. You can set this independently from the root `customize` field.", "type": "boolean" }, "exactMatch": { "description": "Whether the query parameters in the requests match exactly the string items in the corresponding `parameters`. When `false`, substrings match the start of the string. Relevant only if you set the corresponding `option` to either `INCLUDE` or `IGNORE`.", "nullable": true, "type": "boolean" }, "option": { "description": "The configuration option to customize cache keys. You can `INCLUDE` only the specified set of `parameters` in the cache key, or set `IGNORE` to exclude them. `IGNORE_ALL` excludes all parameters from the cache key. Set `INCLUDE_ALL_PRESERVE_ORDER` to key on the full set of parameters in the request's order, or `INCLUDE_ALL_ALPHABETIZE_ORDER` to ignore the original order.", "enum": [ "INCLUDE", "IGNORE", "IGNORE_ALL", "INCLUDE_ALL_PRESERVE_ORDER", "INCLUDE_ALL_ALPHABETIZE_ORDER" ], "nullable": true, "type": "string" }, "parameters": { "description": "Parameters to include in or exclude from cache keys, depending on the `option` you selected. This is only relevant if you set the corresponding `option` to either `INCLUDE` or `IGNORE`.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "nullable": true, "type": "array" } }, "required": [ "customize" ], "type": "object", "x-akamai": { "file-path": "schemas/cache-key-dto.yaml" } }, "inheritsFromEndpoint": { "description": "Whether the resource inherits the top-level API caching settings.", "type": "boolean" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration of keeping content in a cache. If set, overwrites the max age instructions set at the endpoint level.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "methods": { "description": "__Read-only__ The methods assigned to the resource, either `POST`, `GET`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, or `PATCH`.", "items": { "enum": [ "HEAD", "DELETE", "POST", "GET", "OPTIONS", "PUT", "PATCH" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "option": { "default": "CACHE", "description": "The resource caching option, either `CACHE` to enable caching in Akamai platform servers according to the instructions you specify, `BYPASS_CACHE` to send requests straight to origin and disallow caching in downstream caches, `NO_STORE` to disallow caching in Akamai platform servers, `HONOR_ORIGIN_CACHE_CONTROL` to apply caching instructions specified in your origin's `Cache-Control` header, `HONOR_ORIGIN_EXPIRES` to apply caching instructions specified in your origin's `Expires` header, or `HONOR_ORIGIN_CACHE_CONTROL_AND_EXPIRES` to apply caching instructions specified in your origin's `Cache-Control` and `Expires` headers. If set, overwrites the caching instructions set at the endpoint level.", "enum": [ "CACHE", "BYPASS_CACHE", "NO_STORE", "HONOR_ORIGIN_CACHE_CONTROL", "HONOR_ORIGIN_EXPIRES", "HONOR_ORIGIN_CACHE_CONTROL_AND_EXPIRES" ], "type": "string" }, "path": { "description": "__Read-only__ The URL path relative to the hostnames on which the resource resides.", "minLength": 1, "readOnly": true, "type": "string" }, "preRefreshing": { "additionalProperties": false, "description": "Cache prefreshing settings. When enabled, edge servers asynchronously refresh cached objects after a specified percentage of the object's TTL elapses.", "nullable": true, "properties": { "enabled": { "description": "Whether you enable cache prefreshing.", "type": "boolean" }, "value": { "description": "With TTL the duration before cached content ordinarily refreshes, this refreshes content before then, expressed as a percentage of the TTL, from 0 to 99.", "maximum": 99, "minimum": 0, "type": "integer" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/pre-refreshing.yaml" } }, "serveStale": { "description": "Whether to serve stale objects when the origin is unreachable and content revalidation isn't possible.", "type": "boolean" } }, "required": [ "path", "methods", "option", "maxAge", "serveStale", "cacheKey", "preRefreshing", "inheritsFromEndpoint" ], "title": "Resource's caching settings", "type": "object", "x-akamai": { "file-path": "schemas/resources-cache.yaml" } }, "description": "Caching settings for each resource assigned to an endpoint version. This object is a map where the keys are resource IDs and values are cache settings applied to them.", "type": "object" }, "serveStale": { "description": "Whether to serve stale responses when the origin is unreachable and content revalidation isn't possible.", "type": "boolean" } }, "required": [ "customize", "downstreamCaching", "errorCaching", "cacheKey" ], "type": "object", "x-akamai": { "file-path": "schemas/cache-settings-dto.yaml" } } } }, "description": "Operation succeeded." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Edit cache settings", "tags": [ "Cache" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/cache.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/cache" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/cors": { "get": { "description": "Returns the cross-origin resource sharing (CORS) settings configured for an endpoint version.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-cors-settings" }, "operationId": "get-cors-settings", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "allowCredentials": false, "allowedHeaders": [ "Akamai-Cors-Allowed" ], "allowedMethods": [ "GET" ], "allowedOrigins": [ "*" ], "enabled": true, "exposedHeaders": [ "Akamai-Cors-Exposed" ], "preflightMaxAge": 86400 }, "schema": { "additionalProperties": false, "description": "Cross-origin resource sharing (CORS) settings configured for an endpoint. CORS enables clients to request restricted resources from external domains outside the domain that served the first resource. You can configure CORS settings if the API Gateway product is in your contract.", "properties": { "allowCredentials": { "default": false, "description": "Whether you allow credentialed HTTP requests to access your resources. Credentials may be cookies or TLS client certificates.", "type": "boolean" }, "allowedHeaders": { "description": "The HTTP header names that you allow using the `Access-Control-Allow-Headers` header.", "items": { "type": "string" }, "type": "array" }, "allowedMethods": { "description": "The HTTP methods that you allow using the `Access-Control-Allow-Methods` header, either `GET`, `PUT`, `POST`, `DELETE`, `OPTIONS`, `PATCH`, or `HEAD`.", "items": { "enum": [ "GET", "PUT", "POST", "DELETE", "OPTIONS", "PATCH", "HEAD" ], "type": "string" }, "type": "array" }, "allowedOrigins": { "description": "The origin hostnames that you allow using the `Access-Control-Allow-Origin` header. The wildcard (`*`) means all hostnames.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Whether you enabled CORS for the endpoint.", "type": "boolean" }, "exposedHeaders": { "description": "The headers that you expose using the `Access-Control-Expose-Headers` header. By exposing a header, you allow clients to access it.", "items": { "type": "string" }, "type": "array" }, "preflightMaxAge": { "description": "The maximum time in seconds for caching responses to preflight requests.", "type": "integer" } }, "required": [ "enabled", "preflightMaxAge" ], "type": "object", "x-akamai": { "file-path": "schemas/cors-dto.yaml" } } } }, "description": "Response data shows current CORS settings." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Get CORS settings", "tags": [ "CORS" ] }, "put": { "description": "Updates the cross-origin resource sharing (CORS) settings configured for an endpoint version.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/put-cors-settings" }, "operationId": "put-cors-settings", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "allowCredentials": false, "allowedHeaders": [ "Akamai-Cors-Allowed" ], "allowedMethods": [ "GET" ], "allowedOrigins": [ "*" ], "enabled": true, "exposedHeaders": [ "Akamai-Cors-Exposed" ], "preflightMaxAge": 86400 }, "schema": { "additionalProperties": false, "description": "Cross-origin resource sharing (CORS) settings configured for an endpoint. CORS enables clients to request restricted resources from external domains outside the domain that served the first resource. You can configure CORS settings if the API Gateway product is in your contract.", "properties": { "allowCredentials": { "default": false, "description": "Whether you allow credentialed HTTP requests to access your resources. Credentials may be cookies or TLS client certificates.", "example": "{{allowCredentials}}", "type": "boolean" }, "allowedHeaders": { "description": "The HTTP header names that you allow using the `Access-Control-Allow-Headers` header.", "items": { "type": "string" }, "type": "array" }, "allowedMethods": { "description": "The HTTP methods that you allow using the `Access-Control-Allow-Methods` header, either `GET`, `PUT`, `POST`, `DELETE`, `OPTIONS`, `PATCH`, or `HEAD`.", "items": { "enum": [ "GET", "PUT", "POST", "DELETE", "OPTIONS", "PATCH", "HEAD" ], "type": "string" }, "type": "array" }, "allowedOrigins": { "description": "The origin hostnames that you allow using the `Access-Control-Allow-Origin` header. The wildcard (`*`) means all hostnames.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Whether you enabled CORS for the endpoint.", "example": "{{enabled}}", "type": "boolean" }, "exposedHeaders": { "description": "The headers that you expose using the `Access-Control-Expose-Headers` header. By exposing a header, you allow clients to access it.", "items": { "type": "string" }, "type": "array" }, "preflightMaxAge": { "description": "The maximum time in seconds for caching responses to preflight requests.", "example": "{{preflightMaxAge}}", "type": "integer" } }, "required": [ "enabled", "preflightMaxAge" ], "type": "object", "x-akamai": { "file-path": "schemas/cors-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "allowCredentials": false, "allowedHeaders": [ "Akamai-Cors-Allowed" ], "allowedMethods": [ "GET" ], "allowedOrigins": [ "*" ], "enabled": true, "exposedHeaders": [ "Akamai-Cors-Exposed" ], "preflightMaxAge": 86400 }, "schema": { "additionalProperties": false, "description": "Cross-origin resource sharing (CORS) settings configured for an endpoint. CORS enables clients to request restricted resources from external domains outside the domain that served the first resource. You can configure CORS settings if the API Gateway product is in your contract.", "properties": { "allowCredentials": { "default": false, "description": "Whether you allow credentialed HTTP requests to access your resources. Credentials may be cookies or TLS client certificates.", "type": "boolean" }, "allowedHeaders": { "description": "The HTTP header names that you allow using the `Access-Control-Allow-Headers` header.", "items": { "type": "string" }, "type": "array" }, "allowedMethods": { "description": "The HTTP methods that you allow using the `Access-Control-Allow-Methods` header, either `GET`, `PUT`, `POST`, `DELETE`, `OPTIONS`, `PATCH`, or `HEAD`.", "items": { "enum": [ "GET", "PUT", "POST", "DELETE", "OPTIONS", "PATCH", "HEAD" ], "type": "string" }, "type": "array" }, "allowedOrigins": { "description": "The origin hostnames that you allow using the `Access-Control-Allow-Origin` header. The wildcard (`*`) means all hostnames.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Whether you enabled CORS for the endpoint.", "type": "boolean" }, "exposedHeaders": { "description": "The headers that you expose using the `Access-Control-Expose-Headers` header. By exposing a header, you allow clients to access it.", "items": { "type": "string" }, "type": "array" }, "preflightMaxAge": { "description": "The maximum time in seconds for caching responses to preflight requests.", "type": "integer" } }, "required": [ "enabled", "preflightMaxAge" ], "type": "object", "x-akamai": { "file-path": "schemas/cors-dto.yaml" } } } }, "description": "The response shows updated CORS data." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Edit CORS settings", "tags": [ "CORS" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/cors.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/cors" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/error-responses": { "get": { "description": "Returns the error response settings configured for an endpoint version.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-error-response-setting" }, "operationId": "get-error-response-setting", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "API_KEY_FORBIDDEN": { "body": "{\"title\":\"The API key you provided does not have access to the requested resource.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "overrideDefaults": false, "statusCode": 403 }, "API_KEY_INVALID": { "body": "{\"title\":\"The API key you provided does not exist.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "overrideDefaults": false, "statusCode": 401 }, "JWT_CLAIM_VALUE_INVALID": { "body": "{\"title\":\"The JWT claim value did not pass the JWT validation.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "overrideDefaults": false, "statusCode": 401 }, "JWT_SIGNATURE_INVALID": { "body": "{\"title\":\"The JSON web signature in JWT did not pass the JWT validation.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "overrideDefaults": false, "statusCode": 401 }, "QUOTA_EXCEEDED": { "body": "{\"title\":\"The quota limit for the API key you provided has been exceeded during the current time period.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "overrideDefaults": false, "statusCode": 429 } }, "schema": { "additionalProperties": false, "description": "Error response settings configured for an endpoint. If an inbound client request fails, API Gateway returns a default error response with a JSON-formatted description and a status code. You can customize the descriptions, status codes, and headers of selected error responses to help API consumers identify the cause of an error and troubleshoot effectively. You can configure error response settings if the API Gateway product is in your contract.", "properties": { "API_KEY_FORBIDDEN": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } }, "API_KEY_INVALID": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } }, "JWT_CLAIM_VALUE_INVALID": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } }, "JWT_SIGNATURE_INVALID": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } }, "QUOTA_EXCEEDED": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/error-responses-dto.yaml" } } } }, "description": "The response shows current error settings." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Get error response settings", "tags": [ "Error responses" ] }, "put": { "description": "Updates the error response settings configured for an endpoint version.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/put-error-response-setting" }, "operationId": "put-error-response-setting", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "API_KEY_FORBIDDEN": { "body": "{\"title\":\"The API key you provided does not have access to the requested resource.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "statusCode": 403 }, "API_KEY_INVALID": { "body": "{\"title\":\"The API key you provided does not exist.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "statusCode": 401 }, "JWT_CLAIM_VALUE_INVALID": { "body": "{\"title\":\"The JWT claim value did not pass the JWT validation.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "statusCode": 401 }, "JWT_SIGNATURE_INVALID": { "body": "{\"title\":\"The JSON web signature in JWT did not pass the JWT validation.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "statusCode": 401 }, "QUOTA_EXCEEDED": { "body": "{\"title\":\"The quota limit for the API key you provided has been exceeded during the current time period.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "statusCode": 429 } }, "schema": { "additionalProperties": false, "description": "Error response settings configured for an endpoint. If an inbound client request fails, API Gateway returns a default error response with a JSON-formatted description and a status code. You can customize the descriptions, status codes, and headers of selected error responses to help API consumers identify the cause of an error and troubleshoot effectively. You can configure error response settings if the API Gateway product is in your contract.", "properties": { "API_KEY_FORBIDDEN": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } }, "API_KEY_INVALID": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } }, "JWT_CLAIM_VALUE_INVALID": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } }, "JWT_SIGNATURE_INVALID": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } }, "QUOTA_EXCEEDED": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/error-responses-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "API_KEY_FORBIDDEN": { "body": "{\"title\":\"The API key you provided does not have access to the requested resource.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "overrideDefaults": false, "statusCode": 403 }, "API_KEY_INVALID": { "body": "{\"title\":\"The API key you provided does not exist.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "overrideDefaults": false, "statusCode": 401 }, "JWT_CLAIM_VALUE_INVALID": { "body": "{\"title\":\"The JWT claim value did not pass the JWT validation.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "overrideDefaults": false, "statusCode": 401 }, "JWT_SIGNATURE_INVALID": { "body": "{\"title\":\"The JSON web signature in JWT did not pass the JWT validation.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "overrideDefaults": false, "statusCode": 401 }, "QUOTA_EXCEEDED": { "body": "{\"title\":\"The quota limit for the API key you provided has been exceeded during the current time period.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "overrideDefaults": false, "statusCode": 429 } }, "schema": { "additionalProperties": false, "description": "Error response settings configured for an endpoint. If an inbound client request fails, API Gateway returns a default error response with a JSON-formatted description and a status code. You can customize the descriptions, status codes, and headers of selected error responses to help API consumers identify the cause of an error and troubleshoot effectively. You can configure error response settings if the API Gateway product is in your contract.", "properties": { "API_KEY_FORBIDDEN": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } }, "API_KEY_INVALID": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } }, "JWT_CLAIM_VALUE_INVALID": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } }, "JWT_SIGNATURE_INVALID": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } }, "QUOTA_EXCEEDED": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/error-responses-dto.yaml" } } } }, "description": "Operation succeeded." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Edit error response settings", "tags": [ "Error responses" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/error-responses.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/error-responses" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/error-responses/{type}": { "get": { "description": "Returns a customizable error response of the selected type.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-error-responses-type" }, "operationId": "get-error-responses-type", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "body": "{\"title\":\"The API key you provided does not exist.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "overrideDefaults": false, "statusCode": 401 }, "schema": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } } } }, "description": "The response shows the current error response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Get an error response", "tags": [ "Error responses" ] }, "put": { "description": "Updates a customizable error response of the selected type.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/put-get-error-responses-type" }, "operationId": "put-get-error-responses-type", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "body": "{\"title\":\"The API key you provided does not exist.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "statusCode": 401 }, "schema": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "example": "{{body}}", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "example": "{{overrideDefaults}}", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "example": "{{statusCode}}", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "body": "{\"title\":\"The API key you provided does not exist.\" }", "headers": [ { "name": "Content-Type", "value": "application/problem+json" } ], "overrideDefaults": false, "statusCode": 401 }, "schema": { "additionalProperties": false, "description": "A customizable error response. You can customize the following error types: `API_KEY_INVALID`, `API_KEY_FORBIDDEN`, `QUOTA_EXCEEDED`, `JWT_SIGNATURE_INVALID`, `JWT_CLAIM_VALUE_INVALID`.", "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`).", "type": "string" }, "headers": { "description": "HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` field indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "overrideDefaults": { "description": "__Read-only__ Whether you overrode the default error response.", "readOnly": true, "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "type": "integer" } }, "required": [ "statusCode" ], "type": "object", "x-akamai": { "file-path": "schemas/error-response-dto.yaml" } } } }, "description": "The response reflects the updated error response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Edit an error response", "tags": [ "Error responses" ] }, "parameters": [ { "description": "__Enum__ The type of the customizable error response.", "example": "{{type}}", "in": "path", "name": "type", "required": true, "schema": { "enum": [ "API_KEY_INVALID", "API_KEY_FORBIDDEN", "QUOTA_EXCEEDED", "JWT_SIGNATURE_INVALID", "JWT_CLAIM_VALUE_INVALID" ], "example": "API_KEY_INVALID", "type": "string" }, "x-akamai": { "file-path": "parameters/type-path.yaml" } }, { "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/type.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/error-responses/{type}" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/graphql": { "get": { "description": "Returns the GraphQL caching settings configured for an endpoint version.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-graphql-settings" }, "operationId": "get-graphql-settings", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "bodyParamName": "body-param-name", "cacheOrigin": false, "cacheResponseOnError": null, "detectError": false, "downstreamCaching": { "headers": "SAME_AS_ORIGIN", "lifetime": "SMALLER_VALUE", "markAsPrivate": false, "maxAge": null, "option": "ALLOW_CACHING" }, "enabled": true, "maxAge": { "duration": 420, "unit": "HOURS" }, "maxQuerySize": null, "nestingLevel": null, "preRefreshing": { "enabled": true, "value": 50 }, "queryParamName": "query-param-name", "serveStale": null }, "schema": { "additionalProperties": false, "description": "GraphQL caching settings configured for an endpoint. GraphQL caching settings specify properties such as the query and body parameters that contain GraphQL queries, maximum age of cached content, and downstream cacheability. You can configure GraphQL caching settings if the API Gateway product is in your contract.", "properties": { "bodyParamName": { "description": "The name of the JSON body parameter that contains a GraphQL query in an incoming POST request. If the request's content type is `application/json`, this is the name of the key that contains a GraphQL query as its value. If the request's content type is `application/graphql`, edge servers treat the entire request body as a GraphQL query.", "type": "string" }, "cacheOrigin": { "description": "Whether to set the maximum age for caching GraphQL responses (TTL) to the value specified in your origin\u2019s `Cache-Control` HTTP response header.", "nullable": true, "type": "boolean" }, "cacheResponseOnError": { "description": "Whether edge servers should cache the response to a GraphQL-type request in case errors are present in the response body.", "nullable": true, "type": "boolean" }, "detectError": { "description": "By default, GraphQL queries return partial data if only a portion of a request fails. In such cases, status codes don't indicate errors. Instead, an `errors` array in a response body contains error details. This indicates whether edge servers should inspect the response body for the `errors` array.", "type": "boolean" }, "downstreamCaching": { "additionalProperties": false, "description": "Downstream caching settings. Downstream caching refers to the caching instructions assigned to objects sent with responses toward clients, for example browsers, mobile devices, or client proxies.", "properties": { "headers": { "description": "The policy for sending headers downstream, either `CACHE_CONTROL_AND_EXPIRES` to send both `Cache-Control` and `Expires` headers, `CACHE_CONTROL` to send only the `Cache-Control` header, `EXPIRES` to send only the `Expires` header, or `SAME_AS_ORIGIN` to send the same headers as your origin.", "enum": [ "CACHE_CONTROL_AND_EXPIRES", "CACHE_CONTROL", "EXPIRES", "SAME_AS_ORIGIN" ], "type": "string" }, "lifetime": { "default": "SMALLER_VALUE", "description": "The cache lifetime policy, either `SMALLER_VALUE` for a value smaller than specified in the origin header or the remaining edge TTL, `GREATER_VALUE` for a value greater than specified in the origin header or the remaining edge TTL, `REMAINING_EDGE_TTL` for a remaining edge TTL, `FULL_EDGE_TTL` for a full edge TTL, `FIXED_VALUE` for a value that you specify, or `CALCULATES_EXPIRES_FROM_ORIGIN_CACHE_CONTROL` for calculating the maximum age from the origin `Cache-Control` header.", "enum": [ "SMALLER_VALUE", "GREATER_VALUE", "REMAINING_EDGE_TTL", "FULL_EDGE_TTL", "FIXED_VALUE", "CALCULATES_EXPIRES_FROM_ORIGIN_CACHE_CONTROL" ], "type": "string" }, "markAsPrivate": { "description": "Specifies whether to disallow storing responses in a shared cache. This is useful when you want to set a maximum age for the end client, but have shared caches not store the response.", "nullable": true, "type": "boolean" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration to keep content in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "option": { "default": "ALLOW_CACHING", "description": "The option for downstream caching, either `ALLOW_CACHING` to allow downstream caching, `ALLOW_CACHING_REQUIRES_REVALIDATION` to allow downstream caching, but require origin revalidation, `NOT_ALLOW_CACHING` to disallow downstream caching, `PASS_CACHEABILITY_HEADERS_FROM_ORIGIN` to pass cacheability headers from your origin, or `DO_NOT_SEND_HEADERS` to disallow sending headers and apply browser defaults.", "enum": [ "ALLOW_CACHING", "ALLOW_CACHING_REQUIRES_REVALIDATION", "NOT_ALLOW_CACHING", "PASS_CACHEABILITY_HEADERS_FROM_ORIGIN", "DO_NOT_SEND_HEADERS" ], "type": "string" } }, "required": [ "option", "markAsPrivate", "lifetime", "headers", "maxAge" ], "type": "object", "x-akamai": { "file-path": "schemas/cache-downstream-dto.yaml" } }, "enabled": { "description": "Whether you enabled GraphQL caching for the endpoint.", "type": "boolean" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration to keep content in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "maxQuerySize": { "description": "The maximum size of the query. A post body or a get response can't exceed 4 KBs.", "nullable": true, "type": "integer" }, "nestingLevel": { "description": "The number of supported nesting levels within a query. The maximum number is 100.", "nullable": true, "type": "string" }, "preRefreshing": { "additionalProperties": false, "description": "Cache prefreshing settings. When enabled, edge servers asynchronously refresh cached objects after a specified percentage of the object's TTL elapses.", "nullable": true, "properties": { "enabled": { "description": "Whether you enable cache prefreshing.", "type": "boolean" }, "value": { "description": "With TTL the duration before cached content ordinarily refreshes, this refreshes content before then, expressed as a percentage of the TTL, from 0 to 99.", "maximum": 99, "minimum": 0, "type": "integer" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/pre-refreshing.yaml" } }, "queryParamName": { "description": "The name of the query parameter that contains a GraphQL query in an incoming GET or POST request.", "type": "string" }, "serveStale": { "description": "Whether to serve stale responses when the origin is unreachable and content revalidation isn't possible.", "nullable": true, "type": "boolean" } }, "required": [ "enabled", "bodyParamName", "queryParamName", "maxAge", "downstreamCaching", "detectError" ], "type": "object", "x-akamai": { "file-path": "schemas/graph-ql-settings-dto.yaml" } } } }, "description": "The response shows current GraphQL cache settings." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Get GraphQL cache settings", "tags": [ "GraphQL" ] }, "put": { "description": "Updates the GraphQL caching settings configured for an endpoint version.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/put-graphql-settings" }, "operationId": "put-graphql-settings", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "bodyParamName": "body-param-name", "cacheOrigin": false, "cacheResponseOnError": null, "detectError": false, "downstreamCaching": { "headers": "SAME_AS_ORIGIN", "lifetime": "SMALLER_VALUE", "markAsPrivate": false, "maxAge": null, "option": "ALLOW_CACHING" }, "enabled": true, "maxAge": { "duration": 420, "unit": "HOURS" }, "maxQuerySize": null, "nestingLevel": null, "preRefreshing": { "enabled": true, "value": 50 }, "queryParamName": "query-param-name", "serveStale": null }, "schema": { "additionalProperties": false, "description": "GraphQL caching settings configured for an endpoint. GraphQL caching settings specify properties such as the query and body parameters that contain GraphQL queries, maximum age of cached content, and downstream cacheability. You can configure GraphQL caching settings if the API Gateway product is in your contract.", "properties": { "bodyParamName": { "description": "The name of the JSON body parameter that contains a GraphQL query in an incoming POST request. If the request's content type is `application/json`, this is the name of the key that contains a GraphQL query as its value. If the request's content type is `application/graphql`, edge servers treat the entire request body as a GraphQL query.", "example": "{{bodyParamName}}", "type": "string" }, "cacheOrigin": { "description": "Whether to set the maximum age for caching GraphQL responses (TTL) to the value specified in your origin\u2019s `Cache-Control` HTTP response header.", "example": "{{cacheOrigin}}", "nullable": true, "type": "boolean" }, "cacheResponseOnError": { "description": "Whether edge servers should cache the response to a GraphQL-type request in case errors are present in the response body.", "example": "{{cacheResponseOnError}}", "nullable": true, "type": "boolean" }, "detectError": { "description": "By default, GraphQL queries return partial data if only a portion of a request fails. In such cases, status codes don't indicate errors. Instead, an `errors` array in a response body contains error details. This indicates whether edge servers should inspect the response body for the `errors` array.", "example": "{{detectError}}", "type": "boolean" }, "downstreamCaching": { "additionalProperties": false, "description": "Downstream caching settings. Downstream caching refers to the caching instructions assigned to objects sent with responses toward clients, for example browsers, mobile devices, or client proxies.", "properties": { "headers": { "description": "The policy for sending headers downstream, either `CACHE_CONTROL_AND_EXPIRES` to send both `Cache-Control` and `Expires` headers, `CACHE_CONTROL` to send only the `Cache-Control` header, `EXPIRES` to send only the `Expires` header, or `SAME_AS_ORIGIN` to send the same headers as your origin.", "enum": [ "CACHE_CONTROL_AND_EXPIRES", "CACHE_CONTROL", "EXPIRES", "SAME_AS_ORIGIN" ], "type": "string" }, "lifetime": { "default": "SMALLER_VALUE", "description": "The cache lifetime policy, either `SMALLER_VALUE` for a value smaller than specified in the origin header or the remaining edge TTL, `GREATER_VALUE` for a value greater than specified in the origin header or the remaining edge TTL, `REMAINING_EDGE_TTL` for a remaining edge TTL, `FULL_EDGE_TTL` for a full edge TTL, `FIXED_VALUE` for a value that you specify, or `CALCULATES_EXPIRES_FROM_ORIGIN_CACHE_CONTROL` for calculating the maximum age from the origin `Cache-Control` header.", "enum": [ "SMALLER_VALUE", "GREATER_VALUE", "REMAINING_EDGE_TTL", "FULL_EDGE_TTL", "FIXED_VALUE", "CALCULATES_EXPIRES_FROM_ORIGIN_CACHE_CONTROL" ], "type": "string" }, "markAsPrivate": { "description": "Specifies whether to disallow storing responses in a shared cache. This is useful when you want to set a maximum age for the end client, but have shared caches not store the response.", "nullable": true, "type": "boolean" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration to keep content in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "option": { "default": "ALLOW_CACHING", "description": "The option for downstream caching, either `ALLOW_CACHING` to allow downstream caching, `ALLOW_CACHING_REQUIRES_REVALIDATION` to allow downstream caching, but require origin revalidation, `NOT_ALLOW_CACHING` to disallow downstream caching, `PASS_CACHEABILITY_HEADERS_FROM_ORIGIN` to pass cacheability headers from your origin, or `DO_NOT_SEND_HEADERS` to disallow sending headers and apply browser defaults.", "enum": [ "ALLOW_CACHING", "ALLOW_CACHING_REQUIRES_REVALIDATION", "NOT_ALLOW_CACHING", "PASS_CACHEABILITY_HEADERS_FROM_ORIGIN", "DO_NOT_SEND_HEADERS" ], "type": "string" } }, "required": [ "option", "markAsPrivate", "lifetime", "headers", "maxAge" ], "type": "object", "x-akamai": { "file-path": "schemas/cache-downstream-dto.yaml" } }, "enabled": { "description": "Whether you enabled GraphQL caching for the endpoint.", "example": "{{enabled}}", "type": "boolean" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration to keep content in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "maxQuerySize": { "description": "The maximum size of the query. A post body or a get response can't exceed 4 KBs.", "example": "{{maxQuerySize}}", "nullable": true, "type": "integer" }, "nestingLevel": { "description": "The number of supported nesting levels within a query. The maximum number is 100.", "example": "{{nestingLevel}}", "nullable": true, "type": "string" }, "preRefreshing": { "additionalProperties": false, "description": "Cache prefreshing settings. When enabled, edge servers asynchronously refresh cached objects after a specified percentage of the object's TTL elapses.", "nullable": true, "properties": { "enabled": { "description": "Whether you enable cache prefreshing.", "type": "boolean" }, "value": { "description": "With TTL the duration before cached content ordinarily refreshes, this refreshes content before then, expressed as a percentage of the TTL, from 0 to 99.", "maximum": 99, "minimum": 0, "type": "integer" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/pre-refreshing.yaml" } }, "queryParamName": { "description": "The name of the query parameter that contains a GraphQL query in an incoming GET or POST request.", "example": "{{queryParamName}}", "type": "string" }, "serveStale": { "description": "Whether to serve stale responses when the origin is unreachable and content revalidation isn't possible.", "example": "{{serveStale}}", "nullable": true, "type": "boolean" } }, "required": [ "enabled", "bodyParamName", "queryParamName", "maxAge", "downstreamCaching", "detectError" ], "type": "object", "x-akamai": { "file-path": "schemas/graph-ql-settings-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "bodyParamName": "body-param-name", "cacheOrigin": false, "cacheResponseOnError": null, "detectError": false, "downstreamCaching": { "headers": "SAME_AS_ORIGIN", "lifetime": "SMALLER_VALUE", "markAsPrivate": false, "maxAge": null, "option": "ALLOW_CACHING" }, "enabled": true, "maxAge": { "duration": 420, "unit": "HOURS" }, "maxQuerySize": null, "nestingLevel": null, "preRefreshing": { "enabled": true, "value": 50 }, "queryParamName": "query-param-name", "serveStale": null }, "schema": { "additionalProperties": false, "description": "GraphQL caching settings configured for an endpoint. GraphQL caching settings specify properties such as the query and body parameters that contain GraphQL queries, maximum age of cached content, and downstream cacheability. You can configure GraphQL caching settings if the API Gateway product is in your contract.", "properties": { "bodyParamName": { "description": "The name of the JSON body parameter that contains a GraphQL query in an incoming POST request. If the request's content type is `application/json`, this is the name of the key that contains a GraphQL query as its value. If the request's content type is `application/graphql`, edge servers treat the entire request body as a GraphQL query.", "type": "string" }, "cacheOrigin": { "description": "Whether to set the maximum age for caching GraphQL responses (TTL) to the value specified in your origin\u2019s `Cache-Control` HTTP response header.", "nullable": true, "type": "boolean" }, "cacheResponseOnError": { "description": "Whether edge servers should cache the response to a GraphQL-type request in case errors are present in the response body.", "nullable": true, "type": "boolean" }, "detectError": { "description": "By default, GraphQL queries return partial data if only a portion of a request fails. In such cases, status codes don't indicate errors. Instead, an `errors` array in a response body contains error details. This indicates whether edge servers should inspect the response body for the `errors` array.", "type": "boolean" }, "downstreamCaching": { "additionalProperties": false, "description": "Downstream caching settings. Downstream caching refers to the caching instructions assigned to objects sent with responses toward clients, for example browsers, mobile devices, or client proxies.", "properties": { "headers": { "description": "The policy for sending headers downstream, either `CACHE_CONTROL_AND_EXPIRES` to send both `Cache-Control` and `Expires` headers, `CACHE_CONTROL` to send only the `Cache-Control` header, `EXPIRES` to send only the `Expires` header, or `SAME_AS_ORIGIN` to send the same headers as your origin.", "enum": [ "CACHE_CONTROL_AND_EXPIRES", "CACHE_CONTROL", "EXPIRES", "SAME_AS_ORIGIN" ], "type": "string" }, "lifetime": { "default": "SMALLER_VALUE", "description": "The cache lifetime policy, either `SMALLER_VALUE` for a value smaller than specified in the origin header or the remaining edge TTL, `GREATER_VALUE` for a value greater than specified in the origin header or the remaining edge TTL, `REMAINING_EDGE_TTL` for a remaining edge TTL, `FULL_EDGE_TTL` for a full edge TTL, `FIXED_VALUE` for a value that you specify, or `CALCULATES_EXPIRES_FROM_ORIGIN_CACHE_CONTROL` for calculating the maximum age from the origin `Cache-Control` header.", "enum": [ "SMALLER_VALUE", "GREATER_VALUE", "REMAINING_EDGE_TTL", "FULL_EDGE_TTL", "FIXED_VALUE", "CALCULATES_EXPIRES_FROM_ORIGIN_CACHE_CONTROL" ], "type": "string" }, "markAsPrivate": { "description": "Specifies whether to disallow storing responses in a shared cache. This is useful when you want to set a maximum age for the end client, but have shared caches not store the response.", "nullable": true, "type": "boolean" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration to keep content in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "option": { "default": "ALLOW_CACHING", "description": "The option for downstream caching, either `ALLOW_CACHING` to allow downstream caching, `ALLOW_CACHING_REQUIRES_REVALIDATION` to allow downstream caching, but require origin revalidation, `NOT_ALLOW_CACHING` to disallow downstream caching, `PASS_CACHEABILITY_HEADERS_FROM_ORIGIN` to pass cacheability headers from your origin, or `DO_NOT_SEND_HEADERS` to disallow sending headers and apply browser defaults.", "enum": [ "ALLOW_CACHING", "ALLOW_CACHING_REQUIRES_REVALIDATION", "NOT_ALLOW_CACHING", "PASS_CACHEABILITY_HEADERS_FROM_ORIGIN", "DO_NOT_SEND_HEADERS" ], "type": "string" } }, "required": [ "option", "markAsPrivate", "lifetime", "headers", "maxAge" ], "type": "object", "x-akamai": { "file-path": "schemas/cache-downstream-dto.yaml" } }, "enabled": { "description": "Whether you enabled GraphQL caching for the endpoint.", "type": "boolean" }, "maxAge": { "additionalProperties": false, "description": "The maximum duration to keep content in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "maxQuerySize": { "description": "The maximum size of the query. A post body or a get response can't exceed 4 KBs.", "nullable": true, "type": "integer" }, "nestingLevel": { "description": "The number of supported nesting levels within a query. The maximum number is 100.", "nullable": true, "type": "string" }, "preRefreshing": { "additionalProperties": false, "description": "Cache prefreshing settings. When enabled, edge servers asynchronously refresh cached objects after a specified percentage of the object's TTL elapses.", "nullable": true, "properties": { "enabled": { "description": "Whether you enable cache prefreshing.", "type": "boolean" }, "value": { "description": "With TTL the duration before cached content ordinarily refreshes, this refreshes content before then, expressed as a percentage of the TTL, from 0 to 99.", "maximum": 99, "minimum": 0, "type": "integer" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/pre-refreshing.yaml" } }, "queryParamName": { "description": "The name of the query parameter that contains a GraphQL query in an incoming GET or POST request.", "type": "string" }, "serveStale": { "description": "Whether to serve stale responses when the origin is unreachable and content revalidation isn't possible.", "nullable": true, "type": "boolean" } }, "required": [ "enabled", "bodyParamName", "queryParamName", "maxAge", "downstreamCaching", "detectError" ], "type": "object", "x-akamai": { "file-path": "schemas/graph-ql-settings-dto.yaml" } } } }, "description": "The response reflects updated GraphQL cache settings." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Edit GraphQL cache settings", "tags": [ "GraphQL" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/graphql.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/graphql" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/gzip": { "get": { "description": "Returns the GZIP compression settings configured for an endpoint version.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-gzip-settings" }, "operationId": "get-gzip-settings", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "compressResponse": "ALWAYS" }, "schema": { "additionalProperties": false, "description": "GZIP compression settings configured for an endpoint. This feature ensures proper content compression for bandwidth savings. You can configure GZIP compression settings if the API Gateway product is in your contract.", "properties": { "compressResponse": { "default": "ALWAYS", "description": "The type of GZIP compression configuration that you select, either `ALWAYS` for compressing all responses without restrictions, `NEVER` for no GZIP compression, or `SAME_AS_ORIGIN` for the same compression rules as specified for your origin server using the `Content-Encoding` header.", "enum": [ "ALWAYS", "NEVER", "SAME_AS_ORIGIN" ], "type": "string" } }, "required": [ "compressResponse" ], "type": "object", "x-akamai": { "file-path": "schemas/gzip-dto.yaml" } } } }, "description": "The response shows current GZIP settings." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Get GZIP settings", "tags": [ "GZIP" ] }, "put": { "description": "Updates the GZIP compression settings configured for an endpoint version.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/put-gzip-settings" }, "operationId": "put-gzip-settings", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "compressResponse": "ALWAYS" }, "schema": { "additionalProperties": false, "description": "GZIP compression settings configured for an endpoint. This feature ensures proper content compression for bandwidth savings. You can configure GZIP compression settings if the API Gateway product is in your contract.", "properties": { "compressResponse": { "default": "ALWAYS", "description": "The type of GZIP compression configuration that you select, either `ALWAYS` for compressing all responses without restrictions, `NEVER` for no GZIP compression, or `SAME_AS_ORIGIN` for the same compression rules as specified for your origin server using the `Content-Encoding` header.", "enum": [ "ALWAYS", "NEVER", "SAME_AS_ORIGIN" ], "example": "{{compressResponse}}", "type": "string" } }, "required": [ "compressResponse" ], "type": "object", "x-akamai": { "file-path": "schemas/gzip-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "compressResponse": "ALWAYS" }, "schema": { "additionalProperties": false, "description": "GZIP compression settings configured for an endpoint. This feature ensures proper content compression for bandwidth savings. You can configure GZIP compression settings if the API Gateway product is in your contract.", "properties": { "compressResponse": { "default": "ALWAYS", "description": "The type of GZIP compression configuration that you select, either `ALWAYS` for compressing all responses without restrictions, `NEVER` for no GZIP compression, or `SAME_AS_ORIGIN` for the same compression rules as specified for your origin server using the `Content-Encoding` header.", "enum": [ "ALWAYS", "NEVER", "SAME_AS_ORIGIN" ], "type": "string" } }, "required": [ "compressResponse" ], "type": "object", "x-akamai": { "file-path": "schemas/gzip-dto.yaml" } } } }, "description": "The response reflects your updated GZIP settings." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Edit GZIP settings", "tags": [ "GZIP" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/gzip.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/gzip" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/jwt": { "get": { "description": "Returns the JWT validation settings configured for an endpoint version and its assigned resources.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-jwt-settings" }, "operationId": "get-jwt-settings", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "enabled": true, "resources": { "2926712": { "enabled": true, "inheritsFromEndpoint": true, "methods": [ "POST", "GET" ], "notes": "A book item within the bookstore API.", "path": "/book/{bookId}" }, "2935128": { "enabled": true, "inheritsFromEndpoint": true, "methods": [ "POST", "GET", "PUT" ], "notes": "A registered bookstore user.", "path": "/user/{userId}" }, "2935139": { "enabled": true, "inheritsFromEndpoint": true, "methods": [ "GET" ], "notes": "A magazine item within the bookstore API.", "path": "/magazine/{magazineId}" } }, "settings": { "clockSkew": 10, "location": "HEADER", "paramName": "Authorization", "validation": { "claims": [ { "name": "aud", "required": false, "type": "ARRAY", "validate": false, "value": [] }, { "name": "iss", "required": false, "type": "STRING", "validate": true, "value": "Akamai" }, { "name": "sub", "required": false, "type": "REGEX", "validate": true, "value": "^[a-zA-Z0-9_]*$" }, { "name": "exp", "required": false, "type": "TIMESTAMP", "validate": true, "value": null } ], "rsaPublicKeyA": { "content": "-----BEGIN PUBLIC KEY-----\nMIIBIjwE9GQg+OR0WYHtq4AKsvK2eucDs06ejWRDb+uDN\n80jxZCxfweelZKvYT9Qdms/1SJv\nrQIDAQAB\n-----END PUBLIC KEY-----", "name": "publicKey" }, "rsaPublicKeyB": null } } }, "schema": { "additionalProperties": false, "description": "JSON web token (JWT) validation settings configured for an endpoint. JWT is an open standard (RFC 7519) that defines a compact and self-contained method for securely transmitting JSON-encoded information between parties. It's often used for authentication purposes. You can configure JWT validation settings if the API Gateway product is in your contract.", "properties": { "enabled": { "description": "Whether you enabled JWT validation for the endpoint.", "type": "boolean" }, "resources": { "additionalProperties": { "additionalProperties": false, "description": "JWT settings configured for a resource.", "properties": { "enabled": { "description": "Whether you enabled JWT validation for the resource.", "type": "boolean" }, "inheritsFromEndpoint": { "description": "__Read-only__ Whether the resource inherits the top-level JWT settings.", "readOnly": true, "type": "boolean" }, "methods": { "description": "__Read-only__ The methods assigned to the resource, either `POST`, `GET`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, or `PATCH`.", "items": { "enum": [ "HEAD", "DELETE", "POST", "GET", "OPTIONS", "PUT", "PATCH" ], "type": "string" }, "readOnly": true, "type": "array" }, "notes": { "description": "__Read-only__ The description of the resource.", "nullable": true, "readOnly": true, "type": "string" }, "path": { "description": "__Read-only__ The URL path relative to the hostnames on which the resource resides.", "readOnly": true, "type": "string" } }, "required": [ "enabled" ], "type": "object" }, "description": "JWT validation settings for each resource assigned to an endpoint version. The resources are available through a map of `resourceId` keys.", "title": "The map of resource ID to settings.", "type": "object", "x-akamai": { "file-path": "schemas/resources-jwt.yaml" } }, "settings": { "additionalProperties": false, "description": "Endpoint-level JWT settings.", "properties": { "clockSkew": { "description": "The allowed time difference in seconds between the server and client clocks when validating the `exp` and `nbf` JWT claims. The recommended value is 10.", "minimum": 0, "type": "integer" }, "location": { "default": "HEADER", "description": "The location of the JWT in incoming requests, either the default `HEADER` value for a request header, `COOKIE`, or `QUERY` for a query parameter.", "enum": [ "HEADER", "COOKIE", "QUERY" ], "type": "string" }, "paramName": { "description": "The name of the header, cookie, or query parameter that you specified for the JWT location.", "minLength": 1, "type": "string" }, "validation": { "additionalProperties": false, "description": "The JWT validation details, such as RSA public keys and JWT claims.", "properties": { "claims": { "description": "Custom and reserved JWT claims that API Gateway validates in incoming requests. Reserved claims are predefined (as per [RFC 7519](https://tools.ietf.org/html/rfc7519)) and serve as a starting point for your JWT claim configuration. Custom claims refer to both private and public claims and you can define them at will. To prevent claim name collisions, you can register public claims at the [IANA JSON Web Token Claims registry](https://www.iana.org/assignments/jwt/jwt.xhtml) or give them collision-resistant names, such as universally unique identifiers (UUIDs) or object identifiers (OIDs). Private claims usually contain information specific to your organization, such as internal user ID. They're different from public claims as they're not registered at the [IANA JSON Web Token Claims registry](https://www.iana.org/assignments/jwt/jwt.xhtml), and you should use them with care.", "items": { "additionalProperties": false, "nullable": true, "properties": { "name": { "anyOf": [ { "enum": [ "aud", "iss", "sub", "exp", "nbf" ], "title": "A reserved claim", "type": "string" }, { "minLength": 1, "title": "A custom claim", "type": "string" } ], "description": "The name of the JWT claim. For reserved claims, it can either be `aud` to identify the audience for the JWT, `iss` to identify the issuer of the JWT claim, `sub` to identify the subject of the JWT, `exp` to identify the expiration time on or after which the token isn't accepted for processing, or `nbf` to identify the time before which the token isn't accepted for processing. For custom claims, you can use all alphanumeric characters and these characters: `[-_]`. The value isn't case-sensitive for reserved claims and case-sensitive for custom claims. For example, if you enter `AUD` for a value, the system automatically converts it to `aud`, but `scope` and `SCOPE` represent two different values." }, "required": { "description": "Whether the JWT claim needs to be present in incoming requests.", "type": "boolean" }, "type": { "description": "The data type of the JWT claim's value, either `ARRAY`, `STRING`, `INTEGER`, `BOOLEAN`, or `REGEX` if it's a regular expression.", "enum": [ "ARRAY", "STRING", "INTEGER", "BOOLEAN", "REGEX" ], "type": "string" }, "validate": { "description": "Whether to validate the value of the JWT claim at the edge.", "type": "boolean" }, "value": { "oneOf": [ { "items": { "oneOf": [ { "title": "Array of strings", "type": "string" }, { "title": "Array of numbers", "type": "number" } ] }, "nullable": true, "title": "Array", "type": "array" }, { "nullable": true, "title": "String", "type": "string" }, { "nullable": true, "title": "Boolean", "type": "boolean" }, { "nullable": true, "title": "Number", "type": "number" } ] } }, "required": [ "type", "required", "validate" ], "type": "object" }, "minItems": 0, "nullable": true, "type": "array" }, "jwks": { "additionalProperties": false, "description": "A JSON web key set to load public keys from. Specify this object only if the corresponding `method` field is `JWKS`.", "nullable": true, "properties": { "certChain": { "additionalProperties": false, "description": "A PEM file with the certificate to use for validation of hostnames included in the `hosts` field.", "nullable": true, "properties": { "content": { "description": "The contents of the PEM file that contains the certificate.", "minLength": 1, "type": "string" }, "name": { "description": "The name of the PEM file that contains the certificate.", "minLength": 0, "type": "string" } }, "required": [ "name", "content" ], "type": "object" }, "hosts": { "description": "Hostnames that store JSON web key sets. You need to sign each hostname digitally with the certificate chain described in the corresponding `certChain` field.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "jwksSetUrl": { "description": "URL that refers to a resource for a set of JSON-encoded public keys.", "format": "uri", "type": "string" }, "publicKeyMaxAge": { "additionalProperties": false, "description": "The maximum duration to keep a public key in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } } }, "required": [ "publicKeyMaxAge" ], "type": "object" }, "method": { "default": "INLINE_PUBLIC_KEY", "description": "The method of delivering RSA public keys for JWT validation. Either the default `INLINE_PUBLIC_KEY` for periodical manual uploads of public keys, or `JWKS` for a dynamic upload of public keys from specific JWKS URIs.", "enum": [ "INLINE_PUBLIC_KEY", "JWKS" ], "nullable": true, "type": "string" }, "rsaPublicKeyA": { "additionalProperties": false, "description": "The primary RSA public key that you use for JWT validation. The value is `null` if the corresponding `method` field is `JWKS`.", "nullable": true, "properties": { "content": { "description": "The content of the file containing the primary RSA key.", "minLength": 1, "type": "string" }, "name": { "description": "The name of the file containing the primary RSA key.", "minLength": 0, "type": "string" } }, "required": [ "name", "content" ], "type": "object" }, "rsaPublicKeyB": { "additionalProperties": false, "description": "The backup RSA public key for use during key rotations.", "nullable": true, "properties": { "content": { "description": "The content of the file containing the backup RSA key.", "minLength": 1, "type": "string" }, "name": { "description": "The name of the file containing the backup RSA key.", "minLength": 0, "type": "string" } }, "required": [ "name", "content" ], "type": "object" }, "signingAlgorithm": { "description": "Algorithm used to sign tokens issued for your application or API, either `RS256`, `RS384`, `ES256`, or `ES384`. As a component of a JSON Web Token (JWT), this signature authenticates the token's sender and guarantees the message remains unchanged during transmission.", "enum": [ "RS256", "RS384", "ES256", "ES384" ], "nullable": true, "type": "string" } }, "required": [ "rsaPublicKeyA" ], "type": "object" } }, "required": [ "location", "paramName", "clockSkew", "validation" ], "type": "object" } }, "required": [ "enabled", "settings" ], "type": "object", "x-akamai": { "file-path": "schemas/jwt-dto.yaml" } } } }, "description": "The response shows the current JWT validation settings." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Get JWT settings", "tags": [ "JWT" ] }, "put": { "description": "Updates the JWT validation settings configured for an endpoint version and its assigned resources.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/put-jwt-settings" }, "operationId": "put-jwt-settings", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "enabled": true, "resources": { "2926712": { "enabled": true }, "2935128": { "enabled": true }, "2935139": { "enabled": true } }, "settings": { "clockSkew": 10, "location": "HEADER", "paramName": "Authorization", "validation": { "claims": [ { "name": "aud", "required": false, "type": "ARRAY", "validate": false, "value": [] }, { "name": "iss", "required": false, "type": "STRING", "validate": true, "value": "Akamai" }, { "name": "sub", "required": false, "type": "REGEX", "validate": true, "value": "^[a-zA-Z0-9_]*$" }, { "name": "exp", "required": false, "type": "TIMESTAMP", "validate": true, "value": null } ], "rsaPublicKeyA": { "content": "-----BEGIN PUBLIC KEY-----\nMIIBIjwE9GQg+OR0WYHtq4AKsvK2eucDs06ejWRDb+uDN\n80jxZCxfweelZKvYT9Qdms/1SJv\nrQIDAQAB\n-----END PUBLIC KEY-----", "name": "publicKey" }, "rsaPublicKeyB": null } } }, "schema": { "additionalProperties": false, "description": "JSON web token (JWT) validation settings configured for an endpoint. JWT is an open standard (RFC 7519) that defines a compact and self-contained method for securely transmitting JSON-encoded information between parties. It's often used for authentication purposes. You can configure JWT validation settings if the API Gateway product is in your contract.", "properties": { "enabled": { "description": "Whether you enabled JWT validation for the endpoint.", "example": "{{enabled}}", "type": "boolean" }, "resources": { "additionalProperties": { "additionalProperties": false, "description": "JWT settings configured for a resource.", "properties": { "enabled": { "description": "Whether you enabled JWT validation for the resource.", "type": "boolean" }, "inheritsFromEndpoint": { "description": "__Read-only__ Whether the resource inherits the top-level JWT settings.", "readOnly": true, "type": "boolean" }, "methods": { "description": "__Read-only__ The methods assigned to the resource, either `POST`, `GET`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, or `PATCH`.", "items": { "enum": [ "HEAD", "DELETE", "POST", "GET", "OPTIONS", "PUT", "PATCH" ], "type": "string" }, "readOnly": true, "type": "array" }, "notes": { "description": "__Read-only__ The description of the resource.", "nullable": true, "readOnly": true, "type": "string" }, "path": { "description": "__Read-only__ The URL path relative to the hostnames on which the resource resides.", "readOnly": true, "type": "string" } }, "required": [ "enabled" ], "type": "object" }, "description": "JWT validation settings for each resource assigned to an endpoint version. The resources are available through a map of `resourceId` keys.", "title": "The map of resource ID to settings.", "type": "object", "x-akamai": { "file-path": "schemas/resources-jwt.yaml" } }, "settings": { "additionalProperties": false, "description": "Endpoint-level JWT settings.", "properties": { "clockSkew": { "description": "The allowed time difference in seconds between the server and client clocks when validating the `exp` and `nbf` JWT claims. The recommended value is 10.", "minimum": 0, "type": "integer" }, "location": { "default": "HEADER", "description": "The location of the JWT in incoming requests, either the default `HEADER` value for a request header, `COOKIE`, or `QUERY` for a query parameter.", "enum": [ "HEADER", "COOKIE", "QUERY" ], "type": "string" }, "paramName": { "description": "The name of the header, cookie, or query parameter that you specified for the JWT location.", "minLength": 1, "type": "string" }, "validation": { "additionalProperties": false, "description": "The JWT validation details, such as RSA public keys and JWT claims.", "properties": { "claims": { "description": "Custom and reserved JWT claims that API Gateway validates in incoming requests. Reserved claims are predefined (as per [RFC 7519](https://tools.ietf.org/html/rfc7519)) and serve as a starting point for your JWT claim configuration. Custom claims refer to both private and public claims and you can define them at will. To prevent claim name collisions, you can register public claims at the [IANA JSON Web Token Claims registry](https://www.iana.org/assignments/jwt/jwt.xhtml) or give them collision-resistant names, such as universally unique identifiers (UUIDs) or object identifiers (OIDs). Private claims usually contain information specific to your organization, such as internal user ID. They're different from public claims as they're not registered at the [IANA JSON Web Token Claims registry](https://www.iana.org/assignments/jwt/jwt.xhtml), and you should use them with care.", "items": { "additionalProperties": false, "nullable": true, "properties": { "name": { "anyOf": [ { "enum": [ "aud", "iss", "sub", "exp", "nbf" ], "title": "A reserved claim", "type": "string" }, { "minLength": 1, "title": "A custom claim", "type": "string" } ], "description": "The name of the JWT claim. For reserved claims, it can either be `aud` to identify the audience for the JWT, `iss` to identify the issuer of the JWT claim, `sub` to identify the subject of the JWT, `exp` to identify the expiration time on or after which the token isn't accepted for processing, or `nbf` to identify the time before which the token isn't accepted for processing. For custom claims, you can use all alphanumeric characters and these characters: `[-_]`. The value isn't case-sensitive for reserved claims and case-sensitive for custom claims. For example, if you enter `AUD` for a value, the system automatically converts it to `aud`, but `scope` and `SCOPE` represent two different values." }, "required": { "description": "Whether the JWT claim needs to be present in incoming requests.", "type": "boolean" }, "type": { "description": "The data type of the JWT claim's value, either `ARRAY`, `STRING`, `INTEGER`, `BOOLEAN`, or `REGEX` if it's a regular expression.", "enum": [ "ARRAY", "STRING", "INTEGER", "BOOLEAN", "REGEX" ], "type": "string" }, "validate": { "description": "Whether to validate the value of the JWT claim at the edge.", "type": "boolean" }, "value": { "oneOf": [ { "items": { "oneOf": [ { "title": "Array of strings", "type": "string" }, { "title": "Array of numbers", "type": "number" } ] }, "nullable": true, "title": "Array", "type": "array" }, { "nullable": true, "title": "String", "type": "string" }, { "nullable": true, "title": "Boolean", "type": "boolean" }, { "nullable": true, "title": "Number", "type": "number" } ] } }, "required": [ "type", "required", "validate" ], "type": "object" }, "minItems": 0, "nullable": true, "type": "array" }, "jwks": { "additionalProperties": false, "description": "A JSON web key set to load public keys from. Specify this object only if the corresponding `method` field is `JWKS`.", "nullable": true, "properties": { "certChain": { "additionalProperties": false, "description": "A PEM file with the certificate to use for validation of hostnames included in the `hosts` field.", "nullable": true, "properties": { "content": { "description": "The contents of the PEM file that contains the certificate.", "minLength": 1, "type": "string" }, "name": { "description": "The name of the PEM file that contains the certificate.", "minLength": 0, "type": "string" } }, "required": [ "name", "content" ], "type": "object" }, "hosts": { "description": "Hostnames that store JSON web key sets. You need to sign each hostname digitally with the certificate chain described in the corresponding `certChain` field.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "jwksSetUrl": { "description": "URL that refers to a resource for a set of JSON-encoded public keys.", "format": "uri", "type": "string" }, "publicKeyMaxAge": { "additionalProperties": false, "description": "The maximum duration to keep a public key in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } } }, "required": [ "publicKeyMaxAge" ], "type": "object" }, "method": { "default": "INLINE_PUBLIC_KEY", "description": "The method of delivering RSA public keys for JWT validation. Either the default `INLINE_PUBLIC_KEY` for periodical manual uploads of public keys, or `JWKS` for a dynamic upload of public keys from specific JWKS URIs.", "enum": [ "INLINE_PUBLIC_KEY", "JWKS" ], "nullable": true, "type": "string" }, "rsaPublicKeyA": { "additionalProperties": false, "description": "The primary RSA public key that you use for JWT validation. The value is `null` if the corresponding `method` field is `JWKS`.", "nullable": true, "properties": { "content": { "description": "The content of the file containing the primary RSA key.", "minLength": 1, "type": "string" }, "name": { "description": "The name of the file containing the primary RSA key.", "minLength": 0, "type": "string" } }, "required": [ "name", "content" ], "type": "object" }, "rsaPublicKeyB": { "additionalProperties": false, "description": "The backup RSA public key for use during key rotations.", "nullable": true, "properties": { "content": { "description": "The content of the file containing the backup RSA key.", "minLength": 1, "type": "string" }, "name": { "description": "The name of the file containing the backup RSA key.", "minLength": 0, "type": "string" } }, "required": [ "name", "content" ], "type": "object" }, "signingAlgorithm": { "description": "Algorithm used to sign tokens issued for your application or API, either `RS256`, `RS384`, `ES256`, or `ES384`. As a component of a JSON Web Token (JWT), this signature authenticates the token's sender and guarantees the message remains unchanged during transmission.", "enum": [ "RS256", "RS384", "ES256", "ES384" ], "nullable": true, "type": "string" } }, "required": [ "rsaPublicKeyA" ], "type": "object" } }, "required": [ "location", "paramName", "clockSkew", "validation" ], "type": "object" } }, "required": [ "enabled", "settings" ], "type": "object", "x-akamai": { "file-path": "schemas/jwt-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "enabled": true, "resources": { "2926712": { "enabled": true, "inheritsFromEndpoint": true, "methods": [ "POST", "GET" ], "notes": "A book item within the bookstore API.", "path": "/book/{bookId}" }, "2935128": { "enabled": true, "inheritsFromEndpoint": true, "methods": [ "POST", "GET", "PUT" ], "notes": "A registered bookstore user.", "path": "/user/{userId}" }, "2935139": { "enabled": true, "inheritsFromEndpoint": true, "methods": [ "GET" ], "notes": "A magazine item within the bookstore API.", "path": "/magazine/{magazineId}" } }, "settings": { "clockSkew": 10, "location": "HEADER", "paramName": "Authorization", "validation": { "claims": [ { "name": "aud", "required": false, "type": "ARRAY", "validate": false, "value": [] }, { "name": "iss", "required": false, "type": "STRING", "validate": true, "value": "Akamai" }, { "name": "sub", "required": false, "type": "REGEX", "validate": true, "value": "^[a-zA-Z0-9_]*$" }, { "name": "exp", "required": false, "type": "TIMESTAMP", "validate": true, "value": null } ], "rsaPublicKeyA": { "content": "-----BEGIN PUBLIC KEY-----\nMIIBIjwE9GQg+OR0WYHtq4AKsvK2eucDs06ejWRDb+uDN\n80jxZCxfweelZKvYT9Qdms/1SJv\nrQIDAQAB\n-----END PUBLIC KEY-----", "name": "publicKey" }, "rsaPublicKeyB": null } } }, "schema": { "additionalProperties": false, "description": "JSON web token (JWT) validation settings configured for an endpoint. JWT is an open standard (RFC 7519) that defines a compact and self-contained method for securely transmitting JSON-encoded information between parties. It's often used for authentication purposes. You can configure JWT validation settings if the API Gateway product is in your contract.", "properties": { "enabled": { "description": "Whether you enabled JWT validation for the endpoint.", "type": "boolean" }, "resources": { "additionalProperties": { "additionalProperties": false, "description": "JWT settings configured for a resource.", "properties": { "enabled": { "description": "Whether you enabled JWT validation for the resource.", "type": "boolean" }, "inheritsFromEndpoint": { "description": "__Read-only__ Whether the resource inherits the top-level JWT settings.", "readOnly": true, "type": "boolean" }, "methods": { "description": "__Read-only__ The methods assigned to the resource, either `POST`, `GET`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, or `PATCH`.", "items": { "enum": [ "HEAD", "DELETE", "POST", "GET", "OPTIONS", "PUT", "PATCH" ], "type": "string" }, "readOnly": true, "type": "array" }, "notes": { "description": "__Read-only__ The description of the resource.", "nullable": true, "readOnly": true, "type": "string" }, "path": { "description": "__Read-only__ The URL path relative to the hostnames on which the resource resides.", "readOnly": true, "type": "string" } }, "required": [ "enabled" ], "type": "object" }, "description": "JWT validation settings for each resource assigned to an endpoint version. The resources are available through a map of `resourceId` keys.", "title": "The map of resource ID to settings.", "type": "object", "x-akamai": { "file-path": "schemas/resources-jwt.yaml" } }, "settings": { "additionalProperties": false, "description": "Endpoint-level JWT settings.", "properties": { "clockSkew": { "description": "The allowed time difference in seconds between the server and client clocks when validating the `exp` and `nbf` JWT claims. The recommended value is 10.", "minimum": 0, "type": "integer" }, "location": { "default": "HEADER", "description": "The location of the JWT in incoming requests, either the default `HEADER` value for a request header, `COOKIE`, or `QUERY` for a query parameter.", "enum": [ "HEADER", "COOKIE", "QUERY" ], "type": "string" }, "paramName": { "description": "The name of the header, cookie, or query parameter that you specified for the JWT location.", "minLength": 1, "type": "string" }, "validation": { "additionalProperties": false, "description": "The JWT validation details, such as RSA public keys and JWT claims.", "properties": { "claims": { "description": "Custom and reserved JWT claims that API Gateway validates in incoming requests. Reserved claims are predefined (as per [RFC 7519](https://tools.ietf.org/html/rfc7519)) and serve as a starting point for your JWT claim configuration. Custom claims refer to both private and public claims and you can define them at will. To prevent claim name collisions, you can register public claims at the [IANA JSON Web Token Claims registry](https://www.iana.org/assignments/jwt/jwt.xhtml) or give them collision-resistant names, such as universally unique identifiers (UUIDs) or object identifiers (OIDs). Private claims usually contain information specific to your organization, such as internal user ID. They're different from public claims as they're not registered at the [IANA JSON Web Token Claims registry](https://www.iana.org/assignments/jwt/jwt.xhtml), and you should use them with care.", "items": { "additionalProperties": false, "nullable": true, "properties": { "name": { "anyOf": [ { "enum": [ "aud", "iss", "sub", "exp", "nbf" ], "title": "A reserved claim", "type": "string" }, { "minLength": 1, "title": "A custom claim", "type": "string" } ], "description": "The name of the JWT claim. For reserved claims, it can either be `aud` to identify the audience for the JWT, `iss` to identify the issuer of the JWT claim, `sub` to identify the subject of the JWT, `exp` to identify the expiration time on or after which the token isn't accepted for processing, or `nbf` to identify the time before which the token isn't accepted for processing. For custom claims, you can use all alphanumeric characters and these characters: `[-_]`. The value isn't case-sensitive for reserved claims and case-sensitive for custom claims. For example, if you enter `AUD` for a value, the system automatically converts it to `aud`, but `scope` and `SCOPE` represent two different values." }, "required": { "description": "Whether the JWT claim needs to be present in incoming requests.", "type": "boolean" }, "type": { "description": "The data type of the JWT claim's value, either `ARRAY`, `STRING`, `INTEGER`, `BOOLEAN`, or `REGEX` if it's a regular expression.", "enum": [ "ARRAY", "STRING", "INTEGER", "BOOLEAN", "REGEX" ], "type": "string" }, "validate": { "description": "Whether to validate the value of the JWT claim at the edge.", "type": "boolean" }, "value": { "oneOf": [ { "items": { "oneOf": [ { "title": "Array of strings", "type": "string" }, { "title": "Array of numbers", "type": "number" } ] }, "nullable": true, "title": "Array", "type": "array" }, { "nullable": true, "title": "String", "type": "string" }, { "nullable": true, "title": "Boolean", "type": "boolean" }, { "nullable": true, "title": "Number", "type": "number" } ] } }, "required": [ "type", "required", "validate" ], "type": "object" }, "minItems": 0, "nullable": true, "type": "array" }, "jwks": { "additionalProperties": false, "description": "A JSON web key set to load public keys from. Specify this object only if the corresponding `method` field is `JWKS`.", "nullable": true, "properties": { "certChain": { "additionalProperties": false, "description": "A PEM file with the certificate to use for validation of hostnames included in the `hosts` field.", "nullable": true, "properties": { "content": { "description": "The contents of the PEM file that contains the certificate.", "minLength": 1, "type": "string" }, "name": { "description": "The name of the PEM file that contains the certificate.", "minLength": 0, "type": "string" } }, "required": [ "name", "content" ], "type": "object" }, "hosts": { "description": "Hostnames that store JSON web key sets. You need to sign each hostname digitally with the certificate chain described in the corresponding `certChain` field.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "jwksSetUrl": { "description": "URL that refers to a resource for a set of JSON-encoded public keys.", "format": "uri", "type": "string" }, "publicKeyMaxAge": { "additionalProperties": false, "description": "The maximum duration to keep a public key in a cache.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } } }, "required": [ "publicKeyMaxAge" ], "type": "object" }, "method": { "default": "INLINE_PUBLIC_KEY", "description": "The method of delivering RSA public keys for JWT validation. Either the default `INLINE_PUBLIC_KEY` for periodical manual uploads of public keys, or `JWKS` for a dynamic upload of public keys from specific JWKS URIs.", "enum": [ "INLINE_PUBLIC_KEY", "JWKS" ], "nullable": true, "type": "string" }, "rsaPublicKeyA": { "additionalProperties": false, "description": "The primary RSA public key that you use for JWT validation. The value is `null` if the corresponding `method` field is `JWKS`.", "nullable": true, "properties": { "content": { "description": "The content of the file containing the primary RSA key.", "minLength": 1, "type": "string" }, "name": { "description": "The name of the file containing the primary RSA key.", "minLength": 0, "type": "string" } }, "required": [ "name", "content" ], "type": "object" }, "rsaPublicKeyB": { "additionalProperties": false, "description": "The backup RSA public key for use during key rotations.", "nullable": true, "properties": { "content": { "description": "The content of the file containing the backup RSA key.", "minLength": 1, "type": "string" }, "name": { "description": "The name of the file containing the backup RSA key.", "minLength": 0, "type": "string" } }, "required": [ "name", "content" ], "type": "object" }, "signingAlgorithm": { "description": "Algorithm used to sign tokens issued for your application or API, either `RS256`, `RS384`, `ES256`, or `ES384`. As a component of a JSON Web Token (JWT), this signature authenticates the token's sender and guarantees the message remains unchanged during transmission.", "enum": [ "RS256", "RS384", "ES256", "ES384" ], "nullable": true, "type": "string" } }, "required": [ "rsaPublicKeyA" ], "type": "object" } }, "required": [ "location", "paramName", "clockSkew", "validation" ], "type": "object" } }, "required": [ "enabled", "settings" ], "type": "object", "x-akamai": { "file-path": "schemas/jwt-dto.yaml" } } } }, "description": "The response reflects your updated JWT validation settings." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Edit JWT settings", "tags": [ "JWT" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/jwt.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/jwt" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/routing": { "get": { "description": "Returns the incoming request's routing, forwarding, and SureRoute settings configured for an endpoint version. You can run this operation if you're taking part in the API Gateway beta program.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-routing-settings" }, "operationId": "get-routing-settings", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "rules": [ { "conditions": [ { "operator": "IS", "type": "METHOD", "value": "GET" }, { "operator": "IS", "type": "HOSTNAME", "value": "*.www.sqa.rapid.com" } ], "customForwardPath": null, "description": null, "forwardHostHeader": null, "forwardPath": "DEFAULT_PATH", "forwardPort": null, "name": "Forward to the default path", "origin": "rapidzik.hereokuapp.com" } ], "sureRoute": [ { "forceSslForward": false, "origin": "rapidzik.hereokuapp.com", "raceKey": "some-custom-key.com", "raceKeyMode": "CUSTOM", "raceStatTtl": { "duration": 30, "unit": "MINUTES" }, "testObjectPath": "/akamai/testobject.html" } ] }, "schema": { "additionalProperties": false, "description": "An incoming request's routing settings configured for an endpoint. Routing settings specify routing, forwarding, and SureRoute instructions for an endpoint version. You can configure routing settings if the API Gateway product is in your contract and you're taking part in the API Gateway beta program.", "properties": { "rules": { "description": "Routing Rules.", "items": { "additionalProperties": false, "description": "Criteria that identifies which incoming requests to process for an endpoint.", "properties": { "conditions": { "description": "A set of criteria that determines the action the API takes when an incoming request for an endpoint meets the criteria.", "items": { "additionalProperties": false, "properties": { "operator": { "description": "Compares the incoming request to the `type` and `value` fields. The API supports only `IS` as a value.", "enum": [ "IS" ], "type": "string" }, "type": { "description": "Specifies the query string value to match. Use `RESOURCE` to match on a resource like JSON or XML. Use `METHOD` to match on the request method in the request header. Use `HOSTNAME` to match on the hostname in the request's incoming `Host` header.", "enum": [ "RESOURCE", "METHOD", "HOSTNAME" ], "type": "string" }, "value": { "description": "Specifies the string you're trying to match. For flexible URL path matching, use `*` and `?`.", "oneOf": [ { "title": "String", "type": "string" }, { "title": "Number", "type": "number" } ] } }, "type": "object" }, "type": "array" }, "customForwardPath": { "description": "Specifies the request's new forward path when the `forwardPath` value is `CUSTOM_PATH`.", "nullable": true, "type": "string" }, "description": { "description": "Descriptive text for the rule.", "nullable": true, "type": "string" }, "forwardHostHeader": { "description": "Specifies the request's new host header.", "nullable": true, "type": "string" }, "forwardPath": { "description": "Specifies the request's forward path mode, either `DEFAULT_PATH` or `CUSTOM_PATH`.", "enum": [ "DEFAULT_PATH", "CUSTOM_PATH" ], "type": "string" }, "forwardPort": { "description": "Specifies the request's new port number.", "nullable": true, "type": "number" }, "name": { "description": "A unique identifier for the rule.", "type": "string" }, "origin": { "description": "Specifies the request's new origin server destination.", "type": "string" } }, "required": [ "name", "origin", "forwardPath", "conditions" ], "type": "object", "x-akamai": { "file-path": "schemas/routing-rule.yaml" } }, "type": "array" }, "sureRoute": { "description": "SureRoute definitions.", "items": { "additionalProperties": false, "description": "Specifies the SureRoute settings configured for an endpoint.", "properties": { "forceSslForward": { "description": "Forces SureRoute to use SSL when requesting the test object from your alternate origin server. Set the value to `true` when the origin doesn't respond to HTTP requests or responds with a redirect to HTTPS.", "type": "boolean" }, "origin": { "description": "Specifies the origin server where the SureRoute definitions are applied.", "type": "string" }, "raceKey": { "description": "Specifies a custom key to store race results.", "nullable": true, "type": "string" }, "raceKeyMode": { "description": "Specifies which hostname to use to store race results. Either `DEFAULT` for the race destination's hostname or `CUSTOM` for a custom hostname.", "enum": [ "DEFAULT", "CUSTOM" ], "nullable": true, "type": "string" }, "raceStatTtl": { "additionalProperties": false, "description": "Specifies the TTL to hold the SureRoute race results. Races only run when certain thresholds exceed their limit. If traffic drops below the thresholds, the edge server continues to use the last race results to determine the optimal route until this TTL expires. When traffic next increases over the thresholds, the edge server uses the direct route until SureRoute determines a new optimal route.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "testObjectPath": { "description": "Specifies the test object's path on your alternate origin server. SureRoute uses this path in races to test routes. For example, `/akamai/testobject.html`.", "nullable": true, "type": "string" } }, "required": [ "origin", "testObjectPath", "forceSslForward" ], "type": "object", "x-akamai": { "file-path": "schemas/routing-sure-route.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/routing-settings-dto.yaml" } } } }, "description": "The response shows the current routing settings." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Get routing settings", "tags": [ "Routing" ] }, "put": { "description": "Updates the incoming request's routing, forwarding, and SureRoute settings configured for an endpoint version. You can run this operation if you're taking part in the API Gateway beta program.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/put-routing-settings" }, "operationId": "put-routing-settings", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "rules": [ { "conditions": [ { "operator": "IS", "type": "METHOD", "value": "GET" }, { "operator": "IS", "type": "HOSTNAME", "value": "*.www.sqa.rapid.com" } ], "customForwardPath": null, "description": null, "forwardHostHeader": null, "forwardPath": "DEFAULT_PATH", "forwardPort": null, "name": "Forward to the default path", "origin": "rapidzik.hereokuapp.com" } ], "sureRoute": [ { "forceSslForward": false, "origin": "rapidzik.hereokuapp.com", "raceKey": "some-custom-key.com", "raceKeyMode": "CUSTOM", "raceStatTtl": { "duration": 30, "unit": "MINUTES" }, "testObjectPath": "/akamai/testobject.html" } ] }, "schema": { "additionalProperties": false, "description": "An incoming request's routing settings configured for an endpoint. Routing settings specify routing, forwarding, and SureRoute instructions for an endpoint version. You can configure routing settings if the API Gateway product is in your contract and you're taking part in the API Gateway beta program.", "properties": { "rules": { "description": "Routing Rules.", "items": { "additionalProperties": false, "description": "Criteria that identifies which incoming requests to process for an endpoint.", "properties": { "conditions": { "description": "A set of criteria that determines the action the API takes when an incoming request for an endpoint meets the criteria.", "items": { "additionalProperties": false, "properties": { "operator": { "description": "Compares the incoming request to the `type` and `value` fields. The API supports only `IS` as a value.", "enum": [ "IS" ], "type": "string" }, "type": { "description": "Specifies the query string value to match. Use `RESOURCE` to match on a resource like JSON or XML. Use `METHOD` to match on the request method in the request header. Use `HOSTNAME` to match on the hostname in the request's incoming `Host` header.", "enum": [ "RESOURCE", "METHOD", "HOSTNAME" ], "type": "string" }, "value": { "description": "Specifies the string you're trying to match. For flexible URL path matching, use `*` and `?`.", "oneOf": [ { "title": "String", "type": "string" }, { "title": "Number", "type": "number" } ] } }, "type": "object" }, "type": "array" }, "customForwardPath": { "description": "Specifies the request's new forward path when the `forwardPath` value is `CUSTOM_PATH`.", "nullable": true, "type": "string" }, "description": { "description": "Descriptive text for the rule.", "nullable": true, "type": "string" }, "forwardHostHeader": { "description": "Specifies the request's new host header.", "nullable": true, "type": "string" }, "forwardPath": { "description": "Specifies the request's forward path mode, either `DEFAULT_PATH` or `CUSTOM_PATH`.", "enum": [ "DEFAULT_PATH", "CUSTOM_PATH" ], "type": "string" }, "forwardPort": { "description": "Specifies the request's new port number.", "nullable": true, "type": "number" }, "name": { "description": "A unique identifier for the rule.", "type": "string" }, "origin": { "description": "Specifies the request's new origin server destination.", "type": "string" } }, "required": [ "name", "origin", "forwardPath", "conditions" ], "type": "object", "x-akamai": { "file-path": "schemas/routing-rule.yaml" } }, "type": "array" }, "sureRoute": { "description": "SureRoute definitions.", "items": { "additionalProperties": false, "description": "Specifies the SureRoute settings configured for an endpoint.", "properties": { "forceSslForward": { "description": "Forces SureRoute to use SSL when requesting the test object from your alternate origin server. Set the value to `true` when the origin doesn't respond to HTTP requests or responds with a redirect to HTTPS.", "type": "boolean" }, "origin": { "description": "Specifies the origin server where the SureRoute definitions are applied.", "type": "string" }, "raceKey": { "description": "Specifies a custom key to store race results.", "nullable": true, "type": "string" }, "raceKeyMode": { "description": "Specifies which hostname to use to store race results. Either `DEFAULT` for the race destination's hostname or `CUSTOM` for a custom hostname.", "enum": [ "DEFAULT", "CUSTOM" ], "nullable": true, "type": "string" }, "raceStatTtl": { "additionalProperties": false, "description": "Specifies the TTL to hold the SureRoute race results. Races only run when certain thresholds exceed their limit. If traffic drops below the thresholds, the edge server continues to use the last race results to determine the optimal route until this TTL expires. When traffic next increases over the thresholds, the edge server uses the direct route until SureRoute determines a new optimal route.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "testObjectPath": { "description": "Specifies the test object's path on your alternate origin server. SureRoute uses this path in races to test routes. For example, `/akamai/testobject.html`.", "nullable": true, "type": "string" } }, "required": [ "origin", "testObjectPath", "forceSslForward" ], "type": "object", "x-akamai": { "file-path": "schemas/routing-sure-route.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/routing-settings-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "rules": [ { "conditions": [ { "operator": "IS", "type": "METHOD", "value": "GET" }, { "operator": "IS", "type": "HOSTNAME", "value": "*.www.sqa.rapid.com" } ], "customForwardPath": null, "description": null, "forwardHostHeader": null, "forwardPath": "DEFAULT_PATH", "forwardPort": null, "name": "Forward to the default path", "origin": "rapidzik.hereokuapp.com" } ], "sureRoute": [ { "forceSslForward": false, "origin": "rapidzik.hereokuapp.com", "raceKey": "some-custom-key.com", "raceKeyMode": "CUSTOM", "raceStatTtl": { "duration": 30, "unit": "MINUTES" }, "testObjectPath": "/akamai/testobject.html" } ] }, "schema": { "additionalProperties": false, "description": "An incoming request's routing settings configured for an endpoint. Routing settings specify routing, forwarding, and SureRoute instructions for an endpoint version. You can configure routing settings if the API Gateway product is in your contract and you're taking part in the API Gateway beta program.", "properties": { "rules": { "description": "Routing Rules.", "items": { "additionalProperties": false, "description": "Criteria that identifies which incoming requests to process for an endpoint.", "properties": { "conditions": { "description": "A set of criteria that determines the action the API takes when an incoming request for an endpoint meets the criteria.", "items": { "additionalProperties": false, "properties": { "operator": { "description": "Compares the incoming request to the `type` and `value` fields. The API supports only `IS` as a value.", "enum": [ "IS" ], "type": "string" }, "type": { "description": "Specifies the query string value to match. Use `RESOURCE` to match on a resource like JSON or XML. Use `METHOD` to match on the request method in the request header. Use `HOSTNAME` to match on the hostname in the request's incoming `Host` header.", "enum": [ "RESOURCE", "METHOD", "HOSTNAME" ], "type": "string" }, "value": { "description": "Specifies the string you're trying to match. For flexible URL path matching, use `*` and `?`.", "oneOf": [ { "title": "String", "type": "string" }, { "title": "Number", "type": "number" } ] } }, "type": "object" }, "type": "array" }, "customForwardPath": { "description": "Specifies the request's new forward path when the `forwardPath` value is `CUSTOM_PATH`.", "nullable": true, "type": "string" }, "description": { "description": "Descriptive text for the rule.", "nullable": true, "type": "string" }, "forwardHostHeader": { "description": "Specifies the request's new host header.", "nullable": true, "type": "string" }, "forwardPath": { "description": "Specifies the request's forward path mode, either `DEFAULT_PATH` or `CUSTOM_PATH`.", "enum": [ "DEFAULT_PATH", "CUSTOM_PATH" ], "type": "string" }, "forwardPort": { "description": "Specifies the request's new port number.", "nullable": true, "type": "number" }, "name": { "description": "A unique identifier for the rule.", "type": "string" }, "origin": { "description": "Specifies the request's new origin server destination.", "type": "string" } }, "required": [ "name", "origin", "forwardPath", "conditions" ], "type": "object", "x-akamai": { "file-path": "schemas/routing-rule.yaml" } }, "type": "array" }, "sureRoute": { "description": "SureRoute definitions.", "items": { "additionalProperties": false, "description": "Specifies the SureRoute settings configured for an endpoint.", "properties": { "forceSslForward": { "description": "Forces SureRoute to use SSL when requesting the test object from your alternate origin server. Set the value to `true` when the origin doesn't respond to HTTP requests or responds with a redirect to HTTPS.", "type": "boolean" }, "origin": { "description": "Specifies the origin server where the SureRoute definitions are applied.", "type": "string" }, "raceKey": { "description": "Specifies a custom key to store race results.", "nullable": true, "type": "string" }, "raceKeyMode": { "description": "Specifies which hostname to use to store race results. Either `DEFAULT` for the race destination's hostname or `CUSTOM` for a custom hostname.", "enum": [ "DEFAULT", "CUSTOM" ], "nullable": true, "type": "string" }, "raceStatTtl": { "additionalProperties": false, "description": "Specifies the TTL to hold the SureRoute race results. Races only run when certain thresholds exceed their limit. If traffic drops below the thresholds, the edge server continues to use the last race results to determine the optimal route until this TTL expires. When traffic next increases over the thresholds, the edge server uses the direct route until SureRoute determines a new optimal route.", "nullable": true, "properties": { "duration": { "description": "The maximum duration of content caching in the selected unit of time.", "type": "integer" }, "unit": { "description": "The unit of time for content caching, either `SECONDS`, `MINUTES`, `HOURS`, or `DAYS`.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "type": "string" } }, "required": [ "duration", "unit" ], "type": "object", "x-akamai": { "file-path": "schemas/duration-dto.yaml" } }, "testObjectPath": { "description": "Specifies the test object's path on your alternate origin server. SureRoute uses this path in races to test routes. For example, `/akamai/testobject.html`.", "nullable": true, "type": "string" } }, "required": [ "origin", "testObjectPath", "forceSslForward" ], "type": "object", "x-akamai": { "file-path": "schemas/routing-sure-route.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/routing-settings-dto.yaml" } } } }, "description": "The response reflects your updated routing settings." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Some of your request's input is invalid.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The signature does not match", "instance": "https://akab-oehab7atr276tq2v-jf4goiyzjkusb7lc.luna.akamaiapis.net/api-definitions/v2/endpoints/all-versions", "status": 401, "title": "Not authorized", "type": "https://problems.luna.akamaiapis.net/-/pep-authn/deny" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/api-definitions/reference/401). You aren't authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the API endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource not found.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 404, "title": "Not Found", "type": "/api-definitions/error-types/not-found" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). This API endpoint doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "7026cb39-bc76-45ac-9da9-5b65185f963a", "status": 405, "title": "Method Not Allowed", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/api-definitions/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "07cad126-5490-41b7-a99b-fe35a0c6eac4", "status": 415, "title": "Unsupported Media Type", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Unsupported Media Type](https://techdocs.akamai.com/api-definitions/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } } }, "summary": "Edit routing settings", "tags": [ "Routing" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/routing.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/routing" } }, "/endpoints/{apiEndPointId}/versions/{versionNumber}/show": { "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.", "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" }, "operationId": "post-version-show", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "akamaiSecurityRestrictions": null, "apiCategoryIds": [ 2, 7 ], "apiEndPointHosts": [ "bookstore.api.akamai.com" ], "apiEndPointId": 492375, "apiEndPointLocked": false, "apiEndPointName": "Bookstore API", "apiEndPointScheme": "http/https", "apiGatewayEnabled": true, "apiResources": [ { "apiResourceClonedFromId": null, "apiResourceId": 2926712, "apiResourceLogicId": 118435, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578116, "apiParameterId": 1212945, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 494448, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "GET", "apiResourceMethodId": 341591, "apiResourceMethodLogicId": 184404 }, { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 578117, "apiParameterId": 1212946, "apiParameterLocation": "path", "apiParameterName": "bookId", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": { "arrayRestriction": null, "lengthRestriction": { "lengthMax": 15, "lengthMin": 3 }, "numberRangeRestriction": null, "rangeRestriction": null, "xmlConversionRule": null }, "apiParameterType": "string", "apiResourceMethParamId": 494449, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 341592, "apiResourceMethodLogicId": 184405 } ], "apiResourceName": "books", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "A book item within the bookstore API.", "link": null, "lockVersion": 2, "private": false, "resourcePath": "/books/{bookId}", "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin" } ], "availableActions": [ "DELETE", "CLONE_ENDPOINT", "ACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING" ], "basePath": "/bookstore", "caseSensitive": true, "clonedFromVersion": 1, "consumeType": "any", "contractId": "C-0N7RAC71", "createDate": "2019-06-12T13:06:52+0000", "createdBy": "bookstore_admin", "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.", "endpointHidden": false, "groupId": 12345, "isGraphQL": false, "lockVersion": 2, "positiveConstrainsEnabled": null, "productionStatus": null, "productionVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "protectedByApiKey": true, "responseConstraintsEnabled": false, "securityScheme": { "securitySchemeDetail": { "apiKeyLocation": "header", "apiKeyName": "apikey" }, "securitySchemeType": "apikey" }, "source": null, "stagingStatus": null, "stagingVersion": { "lastError": null, "status": null, "timestamp": null, "versionNumber": null }, "updateDate": "2019-06-12T13:06:52+0000", "updatedBy": "bookstore_admin", "versionHidden": false, "versionNumber": 1 }, "schema": { "allOf": [ { "description": "An endpoint and its associated resources.", "properties": { "akamaiSecurityRestrictions": { "additionalProperties": false, "description": "The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.", "nullable": true, "properties": { "ALLOW_ONLY_SPEC_UNDEFINED_METHODS": { "description": "Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_BODY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_COOKIE_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in cookies. These booleans override fields in the Method object. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_HEADER_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_DELETE": { "description": "Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_GET": { "description": "Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_HEAD": { "description": "Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_OPTIONS": { "description": "Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PATCH": { "description": "Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_POST": { "description": "Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_METHOD_PUT": { "description": "Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_PARAMS": { "description": "Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_QUERY_PARAMS": { "description": "Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_RESOURCES": { "description": "Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "ALLOW_UNDEFINED_SPEC_PARAMS": { "description": "Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no.", "enum": [ 1, 0 ], "type": "integer" }, "MAX_BODY_SIZE": { "description": "The maximum allowed size of a request body.", "nullable": true, "type": "integer" }, "MAX_DOC_DEPTH": { "description": "The maximum depth of nested data elements allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_ELEMENT_NAME_LENGTH": { "description": "The maximum length of an XML element name or JSON object key name allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_INTEGER_VALUE": { "description": "The maximum integer value allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_JSONXML_ELEMENT": { "description": "The maximum number of XML elements, JSON object keys, or array items allowed in a request body.", "nullable": true, "type": "integer" }, "MAX_STRING_LENGTH": { "description": "The maximum length of any string value in a request body.", "nullable": true, "type": "integer" }, "POSITIVE_SECURITY_ENABLED": { "description": "Whether to enforce the API request body and resource constraints as allowlists in your App & API Protector security policies. Either `1` for enabled security constraints, or `0` for disabled.", "enum": [ 1, 0 ], "type": "integer" }, "POSITIVE_SECURITY_VERSION": { "description": "Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API.", "enum": [ 1, 2 ], "nullable": true, "type": "integer" }, "RESPONSE_RESTRICTIONS_ENABLED": { "description": "When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`.", "enum": [ 1, 0 ], "type": "integer" } }, "type": "object" }, "apiCategoryIds": { "description": "The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "apiEndPointHosts": { "description": "The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "__Read-only__ The unique identifier for the endpoint.", "nullable": true, "readOnly": true, "type": "integer" }, "apiEndPointLocked": { "description": "__Read-only__ Whether the endpoint version is read-only.", "nullable": true, "readOnly": true, "type": "boolean" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "type": "string" }, "apiEndPointScheme": { "description": "The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both.", "enum": [ "http", "https", "http/https" ], "nullable": true, "type": "string" }, "apiEndPointVersion": { "description": "__Read-only__ The unique identifier for the endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "apiGatewayEnabled": { "default": true, "description": "Whether the API Gateway product should be enabled for the endpoint. If `null`, the field is set to `true`.", "nullable": true, "type": "boolean" }, "apiSource": { "description": "Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`.", "enum": [ "API_DISCOVERY", "USER" ], "nullable": true, "type": "string" }, "apiVersionInfo": { "additionalProperties": false, "description": "A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.", "nullable": true, "properties": { "location": { "description": "The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter.", "enum": [ "HEADER", "BASE_PATH", "QUERY" ], "type": "string" }, "parameterName": { "description": "The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` field is either `HEADER` or `QUERY`.", "type": "string" }, "value": { "description": "The expected API version value in an incoming request.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/api-version-info.yaml" } }, "availableActions": { "description": "__Read-only__ Available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2).", "items": { "enum": [ "DELETE", "CLONE_ENDPOINT", "COMPARE_ENDPOINT", "COMPARE_AAG_SETTINGS", "COMPARE_RAPID_SETTINGS", "EDIT_ENDPOINT_DEFINITION", "ACTIVATE_ON_STAGING", "ACTIVATE_ON_PRODUCTION", "DEACTIVATE_ON_STAGING", "DEACTIVATE_ON_PRODUCTION", "HIDE_ENDPOINT", "SHOW_ENDPOINT" ], "type": "string" }, "minItems": 0, "nullable": true, "readOnly": true, "type": "array" }, "basePath": { "description": "The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "minLength": 0, "nullable": true, "type": "string" }, "caseSensitive": { "description": "Whether the URLs and parameters within the endpoint are case sensitive.", "nullable": true, "type": "boolean" }, "clonedFromVersion": { "description": "__Read-only__ For cloned endpoints, the unique identifier for the source endpoint version.", "nullable": true, "readOnly": true, "type": "integer" }, "consumeType": { "description": "The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string.", "enum": [ "json", "xml", "urlencoded", "json/xml/urlencoded", "json/urlencoded", "json/xml", "xml/urlencoded", "any", "none" ], "nullable": true, "type": "string" }, "contractId": { "description": "__Read-only__ The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "string" }, "createDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you created the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "createdBy": { "description": "__Read-only__ The identifier for the user who created the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "description": { "description": "The description of the endpoint. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "discoveredPiiIds": { "description": "Personally identifiable information (PII) in your API parameters discovered by the network.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "endpointHidden": { "description": "__Read-only__ Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "groupId": { "description": "__Read-only__ The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API.", "nullable": true, "readOnly": true, "type": "integer" }, "isGraphQL": { "description": "Whether the endpoint uses GraphQL to deliver structured content to clients.", "type": "boolean" }, "lockVersion": { "description": "__Read-only__ The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "readOnly": true, "type": "integer" }, "matchPathSegmentParam": { "default": true, "description": "Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`.", "nullable": true, "type": "boolean" }, "positiveConstrainsEnabled": { "description": "Specifies whether the App & API Protector firewall policies are enabled for the endpoint.", "nullable": true, "type": "boolean" }, "productionStatus": { "description": "__Read-only__ The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the production network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "protectedByApiKey": { "description": "__Read-only__ Whether you enabled API key protection for the endpoint version by making the version private.", "readOnly": true, "type": "boolean" }, "responseConstraintsEnabled": { "description": "__Read-only__ Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled.", "nullable": true, "readOnly": true, "type": "boolean" }, "securityScheme": { "additionalProperties": false, "description": "The key with which users may access the endpoint.", "nullable": true, "properties": { "securitySchemeDetail": { "additionalProperties": false, "description": "The location of the API key.", "properties": { "apiKeyLocation": { "description": "The location of the API key in incoming requests, either `header`, `cookie`, or `query` parameter.", "enum": [ "header", "cookie", "query" ], "type": "string" }, "apiKeyName": { "description": "The name of the header, query parameter, or cookie where you located the API key.", "type": "string" } }, "type": "object" }, "securitySchemeType": { "description": "The type of security scheme implemented for the endpoint. The only valid value is `apikey`.", "enum": [ "apikey" ], "type": "string" } }, "type": "object" }, "source": { "additionalProperties": false, "description": "__Read-only__ The import file used to create the endpoint.", "nullable": true, "properties": { "apiVersion": { "description": "__Read-only__ The major version of the API defined in the import file.", "nullable": true, "readOnly": true, "type": "string" }, "specificationVersion": { "description": "__Read-only__ The version of the import file's specification.", "nullable": true, "readOnly": true, "type": "string" }, "type": { "description": "__Read-only__ The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`.", "enum": [ "SWAGGER", "RAML" ], "nullable": true, "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-source-dto.yaml" } }, "stagingStatus": { "description": "__Read-only__ The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "__Read-only__ An endpoint version's activation status on the staging network.", "nullable": true, "properties": { "lastError": { "additionalProperties": false, "description": "The last failed activation of the endpoint version.", "nullable": true, "properties": { "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "type": "object" }, "status": { "description": "__Read-only__ The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last update of the activation status.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "versionNumber": { "description": "__Read-only__ The endpoint version number.", "nullable": true, "readOnly": true, "type": "integer" } }, "readOnly": true, "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-version-status-dto.yaml" } }, "updateDate": { "description": "__Read-only__ The ISO 8601 timestamp indicating when you last modified the endpoint.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "updatedBy": { "description": "__Read-only__ The identifier for the user who last modified the endpoint.", "nullable": true, "readOnly": true, "type": "string" }, "versionHidden": { "description": "__Read-only__ Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation.", "nullable": true, "readOnly": true, "type": "boolean" }, "versionNumber": { "description": "The endpoint version number.", "nullable": true, "type": "integer" } }, "required": [ "apiEndPointName", "apiEndPointHosts", "groupId", "contractId", "lockVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse.yaml" } }, { "type": "object" }, { "properties": { "apiResources": { "description": "Resources assigned to the endpoint.", "items": { "allOf": [ { "description": "A resource assigned to an endpoint.", "properties": { "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "The unique identifier for the resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethodNameLists": { "description": "HTTP methods the resource may respond to.", "items": { "type": "string" }, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "format": "date-time", "type": "string" }, "createdBy": { "description": "The identifier for the user who created the resource.", "type": "string" }, "description": { "description": "The description to clarify the resource's function within the API. If you specify `null` in the request or omit this field from the object, the JSON response reflects it as an empty string.", "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details.", "type": "integer" }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` field in the corresponding parameter definition matches the name that you specified in the resource path.", "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "format": "date-time", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiResourceName", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto.yaml" } }, { "type": "object" }, { "properties": { "apiResourceMethods": { "description": "HTTP methods the resource may respond to.", "items": { "allOf": [ { "type": "object" }, { "description": "An HTTP method to which a resource may respond.", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "GET", "PUT", "POST", "DELETE", "HEAD", "PATCH", "OPTIONS" ], "type": "string" }, "apiResourceMethodId": { "description": "__Read-only__ The unique identifier for the resource's allowed method.", "nullable": true, "readOnly": true, "type": "integer" }, "apiResourceMethodLogicId": { "description": "__Read-only__ The unique identifier for the resource's method across all endpoint versions.", "nullable": true, "readOnly": true, "type": "integer" } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-method-parameters-dto.yaml" } }, { "properties": { "apiParameters": { "description": "Parameter objects assigned to the method.", "items": { "allOf": [ { "description": "A method's parameter.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A further nested endpoint object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "__Read-only__ The unique identifier for the parameter.", "readOnly": true, "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "header", "path", "cookie", "body" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "The description to clarify the parameter's function. If you specify an empty string in the request or omit this field 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 field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Restrictions and XML representation rules specified for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "Restrictions for array type parameters. Define this object only if you enabled the corresponding `array` field.", "nullable": true, "properties": { "collectionFormat": { "default": "csv", "description": "The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "maxItems": { "description": "The maximum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "minItems": { "description": "The minimum allowed number of array items.", "maximum": 256, "minimum": 0, "type": "integer" }, "uniqueItems": { "description": "Whether the array contains only unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Length restrictions for string type parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "nullable": true, "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "nullable": true, "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Range restrictions for number type parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "number" }, "numberRangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "number" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Range restrictions for integer type parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "nullable": true, "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "nullable": true, "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "Response restrictions on the status codes and the response body size.", "properties": { "maxBodySize": { "description": "Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "An XML representation of a JSON-encoded parameter.", "nullable": true, "properties": { "attribute": { "default": false, "description": "Whether the parameter should be represented as an attribute.", "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "type": "string" }, "wrapped": { "default": false, "description": "Whether the parameter should be wrapped in a parent XML element.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/xml-restriction-dto.yaml" } } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects.", "enum": [ "string", "integer", "number", "boolean", "json/xml" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter is within a response type.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameter-dto.yaml" } }, { "type": "object" }, { "properties": { "apiParameterContentType": { "description": "The content type of the parameter, either `json`, `xml`, `any`, or `none`. Only applicable for top-level body parameters.", "enum": [ "json", "xml", "any", "none" ], "type": "string" } }, "type": "object" } ], "description": "A method's parameter.", "x-akamai": { "file-path": "schemas/api-parameter-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An HTTP method to which a resource may respond.", "x-akamai": { "file-path": "schemas/api-method-parameters-dto-response.yaml" } }, "type": "array" } }, "type": "object" } ], "description": "A resource assigned to an endpoint.", "x-akamai": { "file-path": "schemas/api-resource-meth-params-dto-response.yaml" } }, "nullable": true, "type": "array" } }, "type": "object" } ], "description": "An endpoint and its associated resources.", "x-akamai": { "file-path": "schemas/api-endpoint-with-resource-dto-recurse-response.yaml" } } } }, "description": "Operation succeeded." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid data input.", "instance": "d54686b5-21cb-4ab7-a8d6-a92282cf1749", "status": 400, "title": "Bad request", "type": "/api-definitions/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). Invalid data input.", "x-akamai": { "file-path": "errors/400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have access to the endpoint.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "Show a version", "tags": [ "Versions" ] }, "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/version-number-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/api-end-point-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/version-show.yaml", "path-info": "/endpoints/{apiEndPointId}/versions/{versionNumber}/show" } }, "/endpoints/{endpointId}/versions/{versionNumber}/multistep-groups": { "post": { "description": "Create a multistep group with a chosen name. To add operations and create a multistep flow, you need to [list](https://techdocs.akamai.com/api-definitions/reference/get-resources-and-operations) resource operations, and then [get](https://techdocs.akamai.com/api-definitions/reference/get-resource-operation) and [update](https://techdocs.akamai.com/api-definitions/reference/put-resource-operation) each applicable operation to assign it a `multistepGroupId`. ", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/post-multistep-group-details" }, "operationId": "post-multistep-group-details", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "Multistep-Login-Flow" }, "schema": { "additionalProperties": false, "description": "Add information about your multistep group.", "properties": { "name": { "description": "The name of the multistep group.", "example": "{{name}}", "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object", "x-akamai": { "file-path": "schemas/multistep-group-request.yaml" } } } } }, "responses": { "201": { "content": { "application/json": { "example": { "multistepGroupId": "ea7c79cc-f8f5-482a-acd0-4955c385ec1c", "name": "Multistep-Login-Flow" }, "schema": { "additionalProperties": false, "description": "Collect data for your multistep group.", "properties": { "multistepGroupId": { "description": "Identifies the multistep group. This applies only for the following operation types: `LOGIN`, `ACCOUNT_VERIFICATION`, `ACCOUNT_CREATION`, `PASSWORD_RESET`, or `PAYMENT`.", "type": "string" }, "name": { "description": "The name of the multistep group.", "minLength": 1, "type": "string" } }, "required": [ "multistepGroupId", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/multistep-group.yaml" } } } }, "description": "Successful response.", "headers": { "Location": { "description": "A navigable URL path that locates the newly created object.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "#/sensitivity: must have a minimum value of 1", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d13f9326b05ca37d", "status": 400, "title": "Invalid Input Error", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/INVALID-INPUT-ERROR" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). The request body has invalid fields.", "x-akamai": { "file-path": "errors/400-multistep.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to create this resource.", "x-akamai": { "file-path": "errors/403.yaml" } } }, "summary": "Create a multistep group", "tags": [ "Multistep groups" ] }, "get": { "description": "Get the multistep group's name. To find out which operations are a part of this multistep group,[list](https://techdocs.akamai.com/api-definitions/reference/get-resources-and-operations) resource operations and check their `multistepGroupId`. ", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-multistep-group-details" }, "operationId": "get-multistep-group-details", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "multistepGroups": [ { "multistepGroupId": "ea7c79cc-f8f5-482a-acd0-4955c385ec1c", "name": "Multistep-Login-Flow" }, { "multistepGroupId": "da7c79cc-f8f4-482b-acd1-4955c385ec1d", "name": "Multistep-Account-Verification-Flow" } ] }, "schema": { "additionalProperties": false, "properties": { "multistepGroups": { "description": "__Read-only__ Multistep groups.", "items": { "additionalProperties": false, "description": "Collect data for your multistep group.", "properties": { "multistepGroupId": { "description": "Identifies the multistep group. This applies only for the following operation types: `LOGIN`, `ACCOUNT_VERIFICATION`, `ACCOUNT_CREATION`, `PASSWORD_RESET`, or `PAYMENT`.", "type": "string" }, "name": { "description": "The name of the multistep group.", "minLength": 1, "type": "string" } }, "required": [ "multistepGroupId", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/multistep-group.yaml" } }, "readOnly": true, "type": "array" } }, "required": [ "multistepGroups" ], "type": "object", "x-akamai": { "file-path": "schemas/multistep-group-list.yaml" } } } }, "description": "Successful response." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the resource.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "endpoint 1234 version 10 does not exist.", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/c51861f1b4c908b9", "status": 404, "title": "Not Found", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The resource doesn't exist.", "x-akamai": { "file-path": "errors/404-version.yaml" } } }, "summary": "List multistep group details", "tags": [ "Multistep groups" ] }, "parameters": [ { "description": "Identifies an endpoint.", "example": "{{endpointId}}", "in": "path", "name": "endpointId", "required": true, "schema": { "example": 77653, "type": "integer" }, "x-akamai": { "file-path": "parameters/endpoint-id.yaml" } }, { "description": "The endpoint's version.", "example": "{{versionNumber}}", "in": "path", "name": "versionNumber", "required": true, "schema": { "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/version-number.yaml" } } ], "x-akamai": { "file-path": "paths/multistep-groups.yaml", "path-info": "/endpoints/{endpointId}/versions/{versionNumber}/multistep-groups" } }, "/endpoints/{endpointId}/versions/{versionNumber}/multistep-groups/{multistepGroupId}": { "get": { "description": "Get the multistep group's name. To find out which operations are a part of this multistep group, [list](https://techdocs.akamai.com/api-definitions/reference/get-resources-and-operations) resource operations and check their 'multistepGroupId'.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-multistep-groups" }, "operationId": "get-multistep-groups", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "multistepGroupId": "ea7c79cc-f8f5-482a-acd0-4955c385ec1c", "name": "Multistep-Login-Flow" }, "schema": { "additionalProperties": false, "description": "Collect data for your multistep group.", "properties": { "multistepGroupId": { "description": "Identifies the multistep group. This applies only for the following operation types: `LOGIN`, `ACCOUNT_VERIFICATION`, `ACCOUNT_CREATION`, `PASSWORD_RESET`, or `PAYMENT`.", "type": "string" }, "name": { "description": "The name of the multistep group.", "minLength": 1, "type": "string" } }, "required": [ "multistepGroupId", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/multistep-group.yaml" } } } }, "description": "Successful response." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the resource. ", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Multistep Group with id [1234] does not exist.", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/43667dca3dc2da02", "status": 404, "title": "Not Found", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The resource doesn't exist.", "x-akamai": { "file-path": "errors/404-multistep.yaml" } } }, "summary": "Get a multistep group", "tags": [ "Multistep groups" ] }, "put": { "description": "Change the multistep group's name. To assign an operation to a multistep group, modify its 'multistepGroupId' value. You can only add any given operation to a single group.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/put-multistep-groups" }, "operationId": "put-multistep-groups", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "Multistep-Login-Flow" }, "schema": { "additionalProperties": false, "description": "Add information about your multistep group.", "properties": { "name": { "description": "The name of the multistep group.", "example": "{{name}}", "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object", "x-akamai": { "file-path": "schemas/multistep-group-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "multistepGroupId": "ea7c79cc-f8f5-482a-acd0-4955c385ec1c", "name": "Multistep-Login-Flow" }, "schema": { "additionalProperties": false, "description": "Collect data for your multistep group.", "properties": { "multistepGroupId": { "description": "Identifies the multistep group. This applies only for the following operation types: `LOGIN`, `ACCOUNT_VERIFICATION`, `ACCOUNT_CREATION`, `PASSWORD_RESET`, or `PAYMENT`.", "type": "string" }, "name": { "description": "The name of the multistep group.", "minLength": 1, "type": "string" } }, "required": [ "multistepGroupId", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/multistep-group.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "#/sensitivity: must have a minimum value of 1", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d13f9326b05ca37d", "status": 400, "title": "Invalid Input Error", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/INVALID-INPUT-ERROR" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). The request body has invalid fields.", "x-akamai": { "file-path": "errors/400-multistep.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the resource.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Multistep Group with id [1234] does not exist.", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/43667dca3dc2da02", "status": 404, "title": "Not Found", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The requested resource operation doesn't exist.", "x-akamai": { "file-path": "errors/404-multistep.yaml" } } }, "summary": "Update a multistep group", "tags": [ "Multistep groups" ] }, "delete": { "description": "Remove a specific multistep group. This also deletes all operations in this group. ", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/delete-multistep-groups" }, "operationId": "delete-multistep-groups", "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" } } ], "responses": { "204": { "content": {}, "description": "Successful response." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the resource.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Multistep Group with id [1234] does not exist.", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/43667dca3dc2da02", "status": 404, "title": "Not Found", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The requested multistep group doesn't exist.", "x-akamai": { "file-path": "errors/404-multistep.yaml" } } }, "summary": "Delete a multistep group", "tags": [ "Multistep groups" ] }, "parameters": [ { "description": "Identifies an endpoint.", "example": "{{endpointId}}", "in": "path", "name": "endpointId", "required": true, "schema": { "example": 77653, "type": "integer" }, "x-akamai": { "file-path": "parameters/endpoint-id.yaml" } }, { "description": "The endpoint's version.", "example": "{{versionNumber}}", "in": "path", "name": "versionNumber", "required": true, "schema": { "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/version-number.yaml" } }, { "description": "Identifies a multistep group. You must set this value to add an operation to a multistep group. Allowed only for the following operation types: `LOGIN`, `ACCOUNT_VERIFICATION`, `ACCOUNT_CREATION`, `PASSWORD_RESET` and `PAYMENT`.", "example": "{{multistepGroupId}}", "in": "path", "name": "multistepGroupId", "required": true, "schema": { "example": "123e4567-e89b-12d3-a456-426614174000", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "type": "string" }, "x-akamai": { "file-path": "parameters/multistep-group-id.yaml" } } ], "x-akamai": { "file-path": "paths/multistep-group.yaml", "path-info": "/endpoints/{endpointId}/versions/{versionNumber}/multistep-groups/{multistepGroupId}" } }, "/endpoints/{endpointId}/versions/{versionNumber}/resources-and-operations": { "get": { "description": "List all of your resources and resource operations for an API endpoint.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-resources-and-operations" }, "operationId": "get-resources-and-operations", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "apiEndPoints": [ { "apiEndPointHosts": [ "www.bot-staging.net", "www.botman-test1.com", "www.botman-test.com", "www.test-login.com" ], "apiEndPointId": 503130, "apiEndPointName": "E2ETest", "basePath": "/login", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/503130/versions/4", "productionVersion": { "status": "ACTIVE", "timestamp": "2019-10-02T16:04:14+0000", "versionNumber": 4 }, "stagingVersion": { "status": "ACTIVE", "timestamp": "2019-10-02T15:59:07+0000", "versionNumber": 4 } }, { "apiEndPointHosts": [ "www.staging-activated.com" ], "apiEndPointId": 464125, "apiEndPointName": "Activated", "basePath": "/staging", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/464125/versions/2", "productionVersion": {}, "stagingVersion": { "status": "ACTIVE", "timestamp": "2020-03-04T15:28:25+0000", "versionNumber": 2 } }, { "apiEndPointHosts": [ "*.vtest.com", "www.test.com" ], "apiEndPointId": 502216, "apiEndPointName": "Account protections", "basePath": "/webinline", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/502216/versions/2", "productionVersion": {}, "stagingVersion": { "status": "ACTIVE", "timestamp": "2019-09-24T03:03:05+0000", "versionNumber": 2 } }, { "apiEndPointHosts": [ "test.tony.com" ], "apiEndPointId": 291184, "apiEndPointName": "test", "basePath": "/", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/291184/versions/2", "productionVersion": { "status": "ACTIVE", "timestamp": "2018-07-06T16:06:19+0000", "versionNumber": 1 }, "stagingVersion": { "status": "ACTIVE", "timestamp": "2019-04-09T03:39:18+0000", "versionNumber": 2 } } ], "operations": [ { "apiEndPointId": 503130, "apiResourceId": 3143802, "apiResourceLogicId": 122202, "conditions": [ { "apiParameterId": 1636906, "value": "cors/form-login" } ], "link": "/api-definitions/v2/endpoints/503130/versions/4/resources/3143802/operations/123a567b-fe5c-4d52-9cc9-a9cd870f0829", "metadata": { "isActive": true }, "method": "POST", "operationId": "123a567b-fe5c-4d52-9cc9-a9cd870f0829", "operationName": "Form Data", "operationPurpose": "ACCOUNT_VERIFICATION" }, { "apiEndPointId": 493213, "apiResourceId": 3055228, "apiResourceLogicId": 118374, "link": "/api-definitions/v2/endpoints/493213/versions/1/resources/3055228/operations/123a567b-5f82-44e8-95cd-cdcff189a1f2", "metadata": { "isActive": true }, "method": "GET", "operationId": "123a567b-5f82-44e8-95cd-cdcff189a1f2", "operationName": "ProtectedPurpose2", "operationPurpose": "LOYALTY_POINTS" }, { "apiEndPointId": 464125, "apiResourceId": 3545852, "apiResourceLogicId": 106953, "link": "/api-definitions/v2/endpoints/464125/versions/2/resources/3545852/operations/ea603927-99a6-4c25-bd18-b51db7bbff25", "metadata": { "isActive": true }, "method": "GET", "operationId": "ea603927-99a6-4c25-bd18-b51db7bbff25", "operationName": "Purpose1", "operationPurpose": "ACCOUNT_VERIFICATION" }, { "apiEndPointId": 291184, "apiResourceId": 1234567, "apiResourceLogicId": 11737, "conditions": [ { "apiParameterId": 1014208 } ], "link": "/api-definitions/v2/endpoints/291184/versions/2/resources/1234567/operations/c00009d1-64bb-49e5-a492-a81e9aeed1b7", "metadata": { "isActive": true }, "method": "POST", "operationId": "c00009d1-64bb-49e5-a492-a81e9aeed1b7", "operationName": "login", "operationParameter": { "username": { "parameterId": 1014209, "usedForLogin": null } }, "operationPurpose": "LOGIN" } ], "resources": [ { "apiEndPointId": 503130, "apiResourceId": 3143802, "apiResourceLogicId": 122202, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 778229, "apiParameterId": 1636906, "apiParameterLocation": "query", "apiParameterName": "route", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 572570, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 365993, "apiResourceMethodLogicId": 170106, "methodRestrictions": null } ], "apiResourceName": "Login Form Data", "createDate": "2019-10-02T15:39:03+0000", "createdBy": "jsmith", "link": "/api-definitions/v2/endpoints/503130/versions/4/resources/3143802", "lockVersion": 0, "metadata": { "methodsEnabled": 1, "methodsWithOperations": 1, "operationCount": 3 }, "resourcePath": "/index.php", "updateDate": "2019-10-02T15:39:03+0000", "updatedBy": "jsmith" }, { "apiEndPointId": 463140, "apiResourceId": 3545900, "apiResourceLogicId": 106954, "apiResourceMethods": [ { "apiParameters": [], "apiResourceMethod": "POST", "apiResourceMethodId": 474030, "apiResourceMethodLogicId": 147694, "methodRestrictions": null }, { "apiParameters": [], "apiResourceMethod": "GET", "apiResourceMethodId": 474029, "apiResourceMethodLogicId": 147693, "methodRestrictions": null } ], "apiResourceName": "Resource1", "createDate": "2020-03-04T15:24:36+0000", "createdBy": "mrossi", "link": "/api-definitions/v2/endpoints/463140/versions/4/resources/3545900", "lockVersion": 0, "metadata": { "methodsEnabled": 2, "methodsWithOperations": 1, "operationCount": 1 }, "resourcePath": "/index.php", "updateDate": "2020-03-04T15:24:36+0000", "updatedBy": "afero" }, { "apiEndPointId": 464125, "apiResourceId": 3545852, "apiResourceLogicId": 106953, "apiResourceMethods": [ { "apiParameters": [], "apiResourceMethod": "GET", "apiResourceMethodId": 474019, "apiResourceMethodLogicId": 147691, "methodRestrictions": null }, { "apiParameters": [], "apiResourceMethod": "POST", "apiResourceMethodId": 474020, "apiResourceMethodLogicId": 147692, "methodRestrictions": null } ], "apiResourceName": "Resource1", "createDate": "2020-03-04T15:23:59+0000", "createdBy": "jdupont", "link": "/api-definitions/v2/endpoints/464125/versions/2/resources/3545852", "lockVersion": 0, "metadata": { "methodsEnabled": 2, "methodsWithOperations": 1, "operationCount": 1 }, "resourcePath": "/index.php", "updateDate": "2020-03-04T15:23:59+0000", "updatedBy": "szhang" }, { "apiEndPointId": 291184, "apiResourceId": 1234567, "apiResourceLogicId": 11737, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [ { "apiChildParameters": [], "apiParamLogicId": 56167, "apiParameterId": 1014208, "apiParameterLocation": "body", "apiParameterName": "j_password", "apiParameterNotes": null, "apiParameterRequired": false, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": null, "array": false, "pathParamLocationId": null, "response": false }, { "apiChildParameters": [], "apiParamLogicId": 56168, "apiParameterId": 1014209, "apiParameterLocation": "body", "apiParameterName": "j_username", "apiParameterNotes": null, "apiParameterRequired": false, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": null, "array": false, "pathParamLocationId": null, "response": false } ], "apiParamLogicId": 56166, "apiParameterId": 1014207, "apiParameterLocation": "body", "apiParameterName": "root", "apiParameterNotes": null, "apiParameterRequired": false, "apiParameterRestriction": null, "apiParameterType": "json/xml", "apiResourceMethParamId": 412851, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 268261, "apiResourceMethodLogicId": 15869, "methodRestrictions": null } ], "apiResourceName": "test", "createDate": "2019-04-09T03:01:10+0000", "createdBy": "mrossi", "link": "/api-definitions/v2/endpoints/291184/versions/2/resources/1234567", "lockVersion": 0, "metadata": { "methodsEnabled": 1, "methodsWithOperations": 1, "operationCount": 1 }, "resourcePath": "/base", "updateDate": "2019-04-09T03:01:10+0000", "updatedBy": "jdupont" } ] }, "schema": { "additionalProperties": false, "description": "Collects data for the operation report.", "properties": { "apiEndPoints": { "description": "API endpoints and their data.", "items": { "additionalProperties": false, "description": "Collects data about an API endpoint.", "properties": { "apiEndPointHosts": { "description": "API endpoint hostnames.", "items": { "description": "A hostname used to publish the API through Akamai.", "minLength": 1, "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "Identifies the API endpoint.", "type": "integer" }, "apiEndPointName": { "description": "The name of the API endpoint.", "minLength": 1, "type": "string" }, "basePath": { "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` field in the corresponding parameter definition matches the name that you specified in the resource path.", "minLength": 1, "type": "string" }, "caseSensitive": { "description": "Whether to match on case sensitivity.", "type": "boolean" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "minLength": 1, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "Collects data about the API endpoint's activation status.", "properties": { "status": { "description": "The activation status, either `PENDING` if the version contains changes that are being propagated, `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.", "minLength": 1, "nullable": true, "type": "string" }, "timestamp": { "description": "The ISO 8601 timestamp indicating when the activation status was last updated.", "minLength": 1, "nullable": true, "type": "string" }, "versionNumber": { "description": "The endpoint's version.", "nullable": true, "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/activation-status.yaml" } }, "stagingVersion": { "additionalProperties": false, "description": "Collects data about the API endpoint's activation status.", "properties": { "status": { "description": "The activation status, either `PENDING` if the version contains changes that are being propagated, `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.", "minLength": 1, "nullable": true, "type": "string" }, "timestamp": { "description": "The ISO 8601 timestamp indicating when the activation status was last updated.", "minLength": 1, "nullable": true, "type": "string" }, "versionNumber": { "description": "The endpoint's version.", "nullable": true, "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/activation-status.yaml" } } }, "required": [ "apiEndPointId", "apiEndPointHosts", "apiEndPointName", "basePath", "caseSensitive", "link" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-summary.yaml" } }, "type": "array" }, "operations": { "description": "Operations and their data.", "items": { "additionalProperties": false, "description": "Collects data for an operation.", "properties": { "apiEndPointId": { "description": "Identifies the API endpoint.", "type": "integer" }, "apiResourceId": { "description": "Identifies the API resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "conditions": { "description": "Specify the parameter values to match with.", "items": { "additionalProperties": false, "properties": { "apiParameterId": { "description": "Identifies the API parameter.", "type": "integer" }, "value": { "description": "The parameter value to match with.", "nullable": true, "type": "string" } }, "required": [ "apiParameterId" ], "type": "object" }, "nullable": true, "type": "array" }, "failureConditions": { "description": "Specify conditions to capture data on unsuccessful attempts to use the resource. You can set up failure reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "minLength": 1, "type": "string" }, "metadata": { "additionalProperties": false, "description": "Additional information about the operation.", "nullable": true, "properties": { "isActive": { "description": "Informs you if the operation is currently active in production or staging.", "type": "boolean" } }, "type": "object" }, "method": { "description": "The HTTP method used in combination with the resource. Choose between `HEAD`, `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, or `OPTIONS`.", "enum": [ "HEAD", "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS" ], "type": "string" }, "multistepGroupId": { "description": "__Read-only__ Identifies the multistep group for the operation.", "readOnly": true, "type": "string" }, "multistepGroupName": { "description": "__Read-only__ Identifies the multistep group name.", "readOnly": true, "type": "string" }, "operationId": { "description": "__Read-only__ Identifies the operation.", "readOnly": true, "type": "string" }, "operationName": { "description": "The name of the operation. Use the same name you gave to the resource if you only specify one operation.", "minLength": 1, "type": "string" }, "operationParameter": { "additionalProperties": { "additionalProperties": false, "description": "Additional properties describing the parameter.", "properties": { "arrayIndexes": { "description": "Corresponding array parameters used to find data.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "parameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "referenceOperationId": { "description": "Identifies the referred operation.", "nullable": true, "type": "string" }, "referenceOperationLocation": { "description": "Identifies the operation parameter location of the referred operation, either `USERNAME`, `USER_EMAIL`, `USER_PHONE_NUMBER`, `USER_FIRST_NAME`, `USER_LAST_NAME`, or `USER_OTHER_ID`.", "enum": [ "USERNAME", "USER_EMAIL", "USER_PHONE_NUMBER", "USER_OTHER_ID", "USER_FIRST_NAME", "USER_LAST_NAME" ], "nullable": true, "type": "string" }, "usedForLogin": { "description": "Indicates if the parameter is used for login.", "nullable": true, "type": "boolean" } }, "type": "object" }, "description": "Collects data for operation parameters defined when the resource was created.", "nullable": true, "properties": { "userEmail": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userFirstName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userLastName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userOtherId": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userPhoneNumber": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "username": { "description": "If the `operationPurpose` supports a username, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource). Required for `LOGIN`, `ACCOUNT_VERIFICATION`, and `PASSWORD RESET`.", "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/operation-parameter.yaml" } }, "operationPurpose": { "description": "The task this operation serves. Choose between `LOGIN`, `ACCOUNT_VERIFICATION`, `ACCOUNT_CREATION`, `ACCOUNT_UPDATE`, `PASSWORD_RESET`, `PASSWORD_CHANGE`, `PAYMENT`, `GIFTCARD_BALANCE_CHECK`, `LOYALTY_POINTS`, `SEARCH`, `ADD_TO_CART`, or `OTHER`.", "enum": [ "LOGIN", "ACCOUNT_VERIFICATION", "ACCOUNT_CREATION", "ACCOUNT_UPDATE", "PASSWORD_RESET", "PASSWORD_CHANGE", "PAYMENT", "GIFTCARD_BALANCE_CHECK", "LOYALTY_POINTS", "SEARCH", "ADD_TO_CART", "OTHER" ], "type": "string" }, "originUserIdCondition": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "successConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" } }, "required": [ "apiEndPointId", "apiResourceId", "apiResourceLogicId", "link", "operationId", "operationName", "operationPurpose", "method" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-summary.yaml" } }, "type": "array" }, "resources": { "description": "Resources and their data.", "items": { "additionalProperties": false, "description": "Collects data about a resource.", "properties": { "apiEndPointId": { "description": "Identifies the API endpoint.", "type": "integer" }, "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "Identifies the API resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethods": { "description": "Method objects that represent HTTP methods the resource may respond to.", "items": { "additionalProperties": false, "description": "An HTTP method to which a resource may respond.", "properties": { "apiParameters": { "description": "Parameter objects associated with the method.", "items": { "additionalProperties": false, "description": "An HTTP method to which a resource may respond.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A nested API parameter object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameters-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "The unique identifier for the parameter.", "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "body", "header", "path", "cookie" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "Optional notes describing the parameter's function. If you specify an empty string in the request or omit this field from the object, the JSON response reflects it as `null`.", "nullable": true, "type": "string" }, "apiParameterRequired": { "description": "Whether the parameter is needed. If the corresponding `apiParameterLocation` is `path`, set this field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Specify restrictions and XML representation rules for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "If you enabled an `array` field, specify restrictions on array parameters.", "nullable": true, "properties": { "collectionFormat": { "description": "The format of the array that specifies how you separated array values. Choose 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 multiple parameter instances.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "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 unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Specify length restrictions for string parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Specify range restrictions on number parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "type": "integer" }, "numberRangeMin": { "description": "The minimum range restriction.", "type": "integer" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Specify range restrictions for integer parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "The maximum allowed size of the response body.", "nullable": true, "properties": { "maxBodySize": { "description": "Specify the size limit of the response body. Choose `SIZE_6K` for 6KB, `SIZE_8K` for 8KB, `SIZE_12K` for 12KB, or `NO_LIMIT` to allow any response size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "Response status codes to be matched to the response. Specify `null` or leave empty to apply the definition to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "XML settings for the parameter.", "nullable": true, "properties": { "attribute": { "description": "Whether the parameter should be represented as an attribute.", "nullable": true, "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified when you created the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "nullable": true, "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "nullable": true, "type": "string" }, "wrapped": { "description": "Whether the parameter should be wrapped in a parent XML element.", "nullable": true, "type": "boolean" } }, "type": "object" } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean` for cookies, headers, query string, and path parameters. For request body following types are supported: `json`, `xml`, or `json/xml` for either JSON or XML objects, or `urlencoded`.", "enum": [ "string", "integer", "number", "boolean", "json/xml", "json", "xml", "urlencoded" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter belongs to the response.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameters.yaml" } }, "type": "array" }, "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "DELETE", "GET", "PATCH", "PUT", "POST", "OPTIONS", "HEAD" ], "type": "string" }, "apiResourceMethodId": { "description": "The unique identifier for the resource's allowed method.", "type": "integer" }, "apiResourceMethodLogicId": { "description": "The unique identifier for the resource's method across all endpoint versions.", "type": "integer" }, "methodRestrictions": { "additionalProperties": false, "description": "Collects data for restrictions on the method level.", "nullable": true, "properties": { "allowMethodUndefinedParameters": { "additionalProperties": false, "description": "Specify whether undefined parameters are allowed, overriding the top-level setting for undefined parameters.", "properties": { "body": { "description": "Whether undefined parameters are allowed in request body.", "type": "boolean" }, "cookie": { "description": "Whether undefined parameters are allowed in request cookies.", "type": "boolean" }, "header": { "description": "Whether undefined parameters are allowed in request headers.", "type": "boolean" }, "query": { "description": "Whether undefined parameters are allowed in request query string.", "type": "boolean" } }, "required": [ "header", "cookie", "query", "body" ], "type": "object" }, "jsonRequestRejectDuplicates": { "description": "Whether to reject duplicate JSON requests.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/method-restrictions.yaml" } } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-methods.yaml" } }, "nullable": true, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "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 field from the object, the JSON response reflects it as an empty string.", "minLength": 1, "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients. Don't include hostnames.", "minLength": 1, "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](#concurrencycontrol) for details.", "type": "integer" }, "metadata": { "additionalProperties": false, "description": "Information about the number of methods enabled, methods with assigned operations, and operations.", "nullable": true, "properties": { "methodsEnabled": { "description": "The number of methods enabled for the resource.", "type": "integer" }, "methodsWithOperations": { "description": "The number of methods that have assigned operations.", "type": "integer" }, "operationCount": { "description": "The total number of operations assigned to the resource.", "type": "integer" } }, "required": [ "methodsEnabled", "methodsWithOperations", "operationCount" ], "type": "object" }, "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 resource's path, with the API base path omitted. For example, `/login`.", "minLength": 1, "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiEndPointId", "apiResourceId", "apiResourceLogicId", "apiResourceName", "link", "metadata", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-summary.yaml" } }, "type": "array" }, "validation": { "additionalProperties": false, "description": "Contains warnings, errors, or notices determined by validating the match target.", "properties": { "errors": { "description": "__Read-only__ Errors.", "items": { "additionalProperties": false, "description": "Contains feedback on validation.", "properties": { "detail": { "description": "The explanation of the error message.", "type": "string" }, "fieldName": { "description": "The name of the field causing the validation problem.", "type": "string" }, "jsonReference": { "description": "The JSON reference to the field in the resource.", "type": "string" }, "operationId": { "description": "Identifies the operation.", "nullable": true, "type": "string" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "title", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/validation-dto.yaml" } }, "readOnly": true, "type": "array" }, "notices": { "description": "__Read-only__ Notices.", "items": { "additionalProperties": false, "description": "Contains feedback on validation.", "properties": { "detail": { "description": "The explanation of the error message.", "type": "string" }, "fieldName": { "description": "The name of the field causing the validation problem.", "type": "string" }, "jsonReference": { "description": "The JSON reference to the field in the resource.", "type": "string" }, "operationId": { "description": "Identifies the operation.", "nullable": true, "type": "string" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "title", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/validation-dto.yaml" } }, "readOnly": true, "type": "array" }, "warnings": { "description": "__Read-only__ Warnings.", "items": { "additionalProperties": false, "description": "Contains feedback on validation.", "properties": { "detail": { "description": "The explanation of the error message.", "type": "string" }, "fieldName": { "description": "The name of the field causing the validation problem.", "type": "string" }, "jsonReference": { "description": "The JSON reference to the field in the resource.", "type": "string" }, "operationId": { "description": "Identifies the operation.", "nullable": true, "type": "string" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "title", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/validation-dto.yaml" } }, "readOnly": true, "type": "array" } }, "required": [ "notices", "errors", "warnings" ], "type": "object", "x-akamai": { "file-path": "schemas/validation.yaml" } } }, "required": [ "apiEndPoints", "operations", "resources" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-report.yaml" } } } }, "description": "Successful response." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You do not have the necessary access to perform this operation.", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/f1b952dbf3a940a9", "status": 403, "title": "Unauthorized Access/Action", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/UNAUTHORIZED" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the resource.", "x-akamai": { "file-path": "errors/403-error.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "endpoint 1234 version 10 does not exist.", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/c51861f1b4c908b9", "status": 404, "title": "Not Found", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The resource doesn't exist.", "x-akamai": { "file-path": "errors/404-version.yaml" } } }, "summary": "List resources and operations", "tags": [ "Resources and operations" ] }, "parameters": [ { "description": "Identifies an endpoint.", "example": "{{endpointId}}", "in": "path", "name": "endpointId", "required": true, "schema": { "example": 77653, "type": "integer" }, "x-akamai": { "file-path": "parameters/endpoint-id.yaml" } }, { "description": "The endpoint's version.", "example": "{{versionNumber}}", "in": "path", "name": "versionNumber", "required": true, "schema": { "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/version-number.yaml" } } ], "x-akamai": { "file-path": "paths/resources-and-operations.yaml", "path-info": "/endpoints/{endpointId}/versions/{versionNumber}/resources-and-operations" } }, "/endpoints/{endpointId}/versions/{versionNumber}/resources/{apiResourceId}/operations": { "post": { "description": "Create a resource operation. These operations define the purposes of your API resources. Use them to identify the expected usage of your resources to protect endpoints from bot traffic.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/post-resource-operation" }, "operationId": "post-resource-operation", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "apiResourceId": 4102124, "conditions": [ { "apiParameterId": 3828246, "arrayIndexes": [ { "apiParameterId": 4202917, "index": 1 } ] } ], "method": "GET", "operationId": "8f56c3f7-84c3-4b35-a733-b2ecc08be808", "operationName": "login 1", "operationParameter": { "username": { "arrayIndexes": [ { "apiParameterId": 4202917, "index": 0 } ], "parameterId": 4203915, "usedForLogin": true } }, "operationPurpose": "LOGIN", "successConditions": [ { "positiveMatch": true, "type": "HTTP_STATUS", "values": [ "1" ] } ] }, "schema": { "additionalProperties": false, "description": "Collects data for resource operations.", "properties": { "apiResourceId": { "description": "Identifies the API resource.", "example": "{{apiResourceId}}", "type": "integer" }, "conditions": { "description": "Specify the parameter values to match with.", "items": { "additionalProperties": false, "properties": { "apiParameterId": { "description": "Identifies the API parameter.", "type": "integer" }, "arrayIndexes": { "description": "Indexes for corresponding array parameters to find the data parameter.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "positiveMatch": { "description": "Indicates if the value matches the specified parameter value.", "nullable": true, "type": "boolean" }, "value": { "deprecated": true, "description": "__Deprecated__ The parameter value to match with.", "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "values": { "description": "The parameter values to match with.", "items": { "description": "A value to match on.", "minLength": 1, "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "apiParameterId" ], "type": "object" }, "nullable": true, "type": "array" }, "failureConditions": { "description": "Specify conditions to capture data on unsuccessful attempts to use the resource. You can set up failure reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "method": { "description": "HTTP method used to call the resource. Choose either `HEAD`, `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, or `OPTIONS`.", "enum": [ "HEAD", "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS" ], "example": "{{method}}", "type": "string" }, "multiFactorAuthentication": { "description": "Identifies multifactor authenticated operations. It's valid only for `PASSWORD_RESET` and `LOGIN` operations.", "example": "{{multiFactorAuthentication}}", "nullable": true, "type": "boolean" }, "multistepGroupId": { "description": "Identifies the multistep group.", "example": "{{multistepGroupId}}", "nullable": true, "type": "string" }, "operationId": { "description": "__Read-only__ Identifies the operation.", "example": "{{operationId}}", "readOnly": true, "type": "string" }, "operationName": { "description": "The name of the operation. Use the same name you gave to the resource if you only specify one operation.", "example": "{{operationName}}", "minLength": 1, "type": "string" }, "operationParameter": { "additionalProperties": { "additionalProperties": false, "description": "Additional properties describing the parameter.", "properties": { "arrayIndexes": { "description": "Corresponding array parameters used to find data.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "parameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "referenceOperationId": { "description": "Identifies the referred operation.", "nullable": true, "type": "string" }, "referenceOperationLocation": { "description": "Identifies the operation parameter location of the referred operation, either `USERNAME`, `USER_EMAIL`, `USER_PHONE_NUMBER`, `USER_FIRST_NAME`, `USER_LAST_NAME`, or `USER_OTHER_ID`.", "enum": [ "USERNAME", "USER_EMAIL", "USER_PHONE_NUMBER", "USER_OTHER_ID", "USER_FIRST_NAME", "USER_LAST_NAME" ], "nullable": true, "type": "string" }, "usedForLogin": { "description": "Indicates if the parameter is used for login.", "nullable": true, "type": "boolean" } }, "type": "object" }, "description": "Collects data for operation parameters defined when the resource was created.", "nullable": true, "properties": { "userEmail": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userFirstName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userLastName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userOtherId": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userPhoneNumber": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "username": { "description": "If the `operationPurpose` supports a username, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource). Required for `LOGIN`, `ACCOUNT_VERIFICATION`, and `PASSWORD RESET`.", "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/operation-parameter.yaml" } }, "operationPurpose": { "description": "The task this operation serves. Choose either `LOGIN`, `ACCOUNT_UPDATE`, `ACCOUNT_VERIFICATION`, `ACCOUNT_CREATION`, `PASSWORD_CHANGE`, `PASSWORD_RESET`, `PAYMENT`, `GIFTCARD_BALANCE_CHECK`, `LOYALTY_POINTS`, `SEARCH`, or `ADD_TO_CART`. See [Operation purposes](https://techdocs.akamai.com/api-definitions/reference/operation-purposes) for details.", "enum": [ "LOGIN", "ACCOUNT_UPDATE", "ACCOUNT_VERIFICATION", "ACCOUNT_CREATION", "PASSWORD_CHANGE", "PASSWORD_RESET", "PAYMENT", "GIFTCARD_BALANCE_CHECK", "LOYALTY_POINTS", "SEARCH", "ADD_TO_CART" ], "example": "{{operationPurpose}}", "type": "string" }, "originUserIdCondition": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "stepSuccessConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`. This is allowed only for operations in a multistep group.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "successConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" } }, "required": [ "apiResourceId", "method", "operationName", "operationPurpose" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-operation.yaml" } } } } }, "responses": { "201": { "content": { "application/json": { "example": { "apiResourceId": 4102124, "conditions": [ { "apiParameterId": 3828246 } ], "method": "GET", "operationId": "e03cf501-b09b-49fa-b3c8-c3fa6787a359", "operationName": "login 1", "operationParameter": { "userEmail": { "parameterId": 1234567, "usedForLogin": true }, "userFirstName": { "parameterId": 1234567 }, "userLastName": { "parameterId": 1234567 }, "userOtherId": { "parameterId": 1234567, "usedForLogin": true }, "userPhoneNumber": { "parameterId": 1234567, "usedForLogin": true }, "username": { "parameterId": 1234567 } }, "operationPurpose": "LOGIN", "successConditions": [ { "positiveMatch": true, "type": "HTTP_STATUS", "values": [ "1" ] } ] }, "schema": { "additionalProperties": false, "description": "Collects data for resource operations.", "properties": { "apiResourceId": { "description": "Identifies the API resource.", "type": "integer" }, "conditions": { "description": "Specify the parameter values to match with.", "items": { "additionalProperties": false, "properties": { "apiParameterId": { "description": "Identifies the API parameter.", "type": "integer" }, "arrayIndexes": { "description": "Indexes for corresponding array parameters to find the data parameter.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "positiveMatch": { "description": "Indicates if the value matches the specified parameter value.", "nullable": true, "type": "boolean" }, "value": { "deprecated": true, "description": "__Deprecated__ The parameter value to match with.", "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "values": { "description": "The parameter values to match with.", "items": { "description": "A value to match on.", "minLength": 1, "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "apiParameterId" ], "type": "object" }, "nullable": true, "type": "array" }, "failureConditions": { "description": "Specify conditions to capture data on unsuccessful attempts to use the resource. You can set up failure reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "method": { "description": "HTTP method used to call the resource. Choose either `HEAD`, `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, or `OPTIONS`.", "enum": [ "HEAD", "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS" ], "type": "string" }, "multiFactorAuthentication": { "description": "Identifies multifactor authenticated operations. It's valid only for `PASSWORD_RESET` and `LOGIN` operations.", "nullable": true, "type": "boolean" }, "multistepGroupId": { "description": "Identifies the multistep group.", "nullable": true, "type": "string" }, "operationId": { "description": "__Read-only__ Identifies the operation.", "readOnly": true, "type": "string" }, "operationName": { "description": "The name of the operation. Use the same name you gave to the resource if you only specify one operation.", "minLength": 1, "type": "string" }, "operationParameter": { "additionalProperties": { "additionalProperties": false, "description": "Additional properties describing the parameter.", "properties": { "arrayIndexes": { "description": "Corresponding array parameters used to find data.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "parameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "referenceOperationId": { "description": "Identifies the referred operation.", "nullable": true, "type": "string" }, "referenceOperationLocation": { "description": "Identifies the operation parameter location of the referred operation, either `USERNAME`, `USER_EMAIL`, `USER_PHONE_NUMBER`, `USER_FIRST_NAME`, `USER_LAST_NAME`, or `USER_OTHER_ID`.", "enum": [ "USERNAME", "USER_EMAIL", "USER_PHONE_NUMBER", "USER_OTHER_ID", "USER_FIRST_NAME", "USER_LAST_NAME" ], "nullable": true, "type": "string" }, "usedForLogin": { "description": "Indicates if the parameter is used for login.", "nullable": true, "type": "boolean" } }, "type": "object" }, "description": "Collects data for operation parameters defined when the resource was created.", "nullable": true, "properties": { "userEmail": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userFirstName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userLastName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userOtherId": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userPhoneNumber": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "username": { "description": "If the `operationPurpose` supports a username, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource). Required for `LOGIN`, `ACCOUNT_VERIFICATION`, and `PASSWORD RESET`.", "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/operation-parameter.yaml" } }, "operationPurpose": { "description": "The task this operation serves. Choose either `LOGIN`, `ACCOUNT_UPDATE`, `ACCOUNT_VERIFICATION`, `ACCOUNT_CREATION`, `PASSWORD_CHANGE`, `PASSWORD_RESET`, `PAYMENT`, `GIFTCARD_BALANCE_CHECK`, `LOYALTY_POINTS`, `SEARCH`, or `ADD_TO_CART`. See [Operation purposes](https://techdocs.akamai.com/api-definitions/reference/operation-purposes) for details.", "enum": [ "LOGIN", "ACCOUNT_UPDATE", "ACCOUNT_VERIFICATION", "ACCOUNT_CREATION", "PASSWORD_CHANGE", "PASSWORD_RESET", "PAYMENT", "GIFTCARD_BALANCE_CHECK", "LOYALTY_POINTS", "SEARCH", "ADD_TO_CART" ], "type": "string" }, "originUserIdCondition": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "stepSuccessConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`. This is allowed only for operations in a multistep group.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "successConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" } }, "required": [ "apiResourceId", "method", "operationName", "operationPurpose" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-operation.yaml" } } } }, "description": "Successful response.", "headers": { "Location": { "description": "A navigable URL path that locates the newly created object.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "#/sensitivity: must have a minimum value of 1", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d13f9326b05ca37d", "status": 400, "title": "Invalid Input Error", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/INVALID-INPUT-ERROR" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). The request body has invalid fields.", "x-akamai": { "file-path": "errors/400-resource.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You do not have the necessary access to perform this operation.", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/f1b952dbf3a940a9", "status": 403, "title": "Unauthorized Access/Action", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/UNAUTHORIZED" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to create this resource.", "x-akamai": { "file-path": "errors/403-error.yaml" } } }, "summary": "Create a resource operation", "tags": [ "Resource operations" ] }, "get": { "description": "List all of your resource operations and their resources.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-resource-operations" }, "operationId": "get-resource-operations", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "operations": [ { "apiResourceId": 4102124, "conditions": [ { "apiParameterId": 3828246, "value": "header_matches" }, { "apiParameterId": 3828247, "value": "cookie_matches" }, { "apiParameterId": 3828248 }, { "apiParameterId": 3828249 } ], "method": "GET", "operationId": "8dac269e-0ee4-4953-b476-647eb969f834", "operationName": "account_verification 1", "operationPurpose": "ACCOUNT_VERIFICATION", "successConditions": [ { "headerName": "header_value_match_name", "positiveMatch": true, "suppressFromClientResponse": false, "type": "HEADER_VALUE", "valueCase": false, "valueWildcard": false, "values": [ "header_value_match_value", "another_header_value" ] }, { "headerName": "header_value_no_match_name", "positiveMatch": false, "suppressFromClientResponse": false, "type": "HEADER_VALUE", "valueCase": false, "valueWildcard": false, "values": [ "header_value_no_match_value" ] }, { "headerName": "header_less_than", "suppressFromClientResponse": false, "type": "HEADER_VALUE_LESS_THAN", "values": [ "1" ] }, { "headerName": "header_greater_than", "suppressFromClientResponse": false, "type": "HEADER_VALUE_GREATER_THAN", "values": [ "2" ] }, { "headerName": "header_between", "suppressFromClientResponse": false, "type": "HEADER_VALUE_BETWEEN", "values": [ "1", "2" ] }, { "positiveMatch": false, "type": "HTTP_STATUS", "values": [ "0x1", "1.0" ] }, { "positiveMatch": false, "suppressFromClientResponse": false, "type": "COOKIE_NAME", "valueCase": false, "values": [ "cookie_name_match" ] }, { "positiveMatch": false, "suppressFromClientResponse": false, "type": "COOKIE_NAME", "valueCase": false, "values": [ "cookie_name_match2" ] } ] }, { "apiResourceId": 4102124, "method": "GET", "operationId": "cb047773-4dad-4634-800b-62b3ae19af1d", "operationName": "login 1", "operationPurpose": "LOGIN" } ] }, "schema": { "additionalProperties": false, "properties": { "operations": { "description": "__Read-only__ Resource operations.", "items": { "additionalProperties": false, "description": "Collects data for resource operations.", "properties": { "apiResourceId": { "description": "Identifies the API resource.", "type": "integer" }, "conditions": { "description": "Specify the parameter values to match with.", "items": { "additionalProperties": false, "properties": { "apiParameterId": { "description": "Identifies the API parameter.", "type": "integer" }, "arrayIndexes": { "description": "Indexes for corresponding array parameters to find the data parameter.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "positiveMatch": { "description": "Indicates if the value matches the specified parameter value.", "nullable": true, "type": "boolean" }, "value": { "deprecated": true, "description": "__Deprecated__ The parameter value to match with.", "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "values": { "description": "The parameter values to match with.", "items": { "description": "A value to match on.", "minLength": 1, "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "apiParameterId" ], "type": "object" }, "nullable": true, "type": "array" }, "failureConditions": { "description": "Specify conditions to capture data on unsuccessful attempts to use the resource. You can set up failure reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "method": { "description": "HTTP method used to call the resource. Choose either `HEAD`, `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, or `OPTIONS`.", "enum": [ "HEAD", "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS" ], "type": "string" }, "multiFactorAuthentication": { "description": "Identifies multifactor authenticated operations. It's valid only for `PASSWORD_RESET` and `LOGIN` operations.", "nullable": true, "type": "boolean" }, "multistepGroupId": { "description": "Identifies the multistep group.", "nullable": true, "type": "string" }, "operationId": { "description": "__Read-only__ Identifies the operation.", "readOnly": true, "type": "string" }, "operationName": { "description": "The name of the operation. Use the same name you gave to the resource if you only specify one operation.", "minLength": 1, "type": "string" }, "operationParameter": { "additionalProperties": { "additionalProperties": false, "description": "Additional properties describing the parameter.", "properties": { "arrayIndexes": { "description": "Corresponding array parameters used to find data.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "parameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "referenceOperationId": { "description": "Identifies the referred operation.", "nullable": true, "type": "string" }, "referenceOperationLocation": { "description": "Identifies the operation parameter location of the referred operation, either `USERNAME`, `USER_EMAIL`, `USER_PHONE_NUMBER`, `USER_FIRST_NAME`, `USER_LAST_NAME`, or `USER_OTHER_ID`.", "enum": [ "USERNAME", "USER_EMAIL", "USER_PHONE_NUMBER", "USER_OTHER_ID", "USER_FIRST_NAME", "USER_LAST_NAME" ], "nullable": true, "type": "string" }, "usedForLogin": { "description": "Indicates if the parameter is used for login.", "nullable": true, "type": "boolean" } }, "type": "object" }, "description": "Collects data for operation parameters defined when the resource was created.", "nullable": true, "properties": { "userEmail": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userFirstName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userLastName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userOtherId": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userPhoneNumber": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "username": { "description": "If the `operationPurpose` supports a username, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource). Required for `LOGIN`, `ACCOUNT_VERIFICATION`, and `PASSWORD RESET`.", "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/operation-parameter.yaml" } }, "operationPurpose": { "description": "The task this operation serves. Choose either `LOGIN`, `ACCOUNT_UPDATE`, `ACCOUNT_VERIFICATION`, `ACCOUNT_CREATION`, `PASSWORD_CHANGE`, `PASSWORD_RESET`, `PAYMENT`, `GIFTCARD_BALANCE_CHECK`, `LOYALTY_POINTS`, `SEARCH`, or `ADD_TO_CART`. See [Operation purposes](https://techdocs.akamai.com/api-definitions/reference/operation-purposes) for details.", "enum": [ "LOGIN", "ACCOUNT_UPDATE", "ACCOUNT_VERIFICATION", "ACCOUNT_CREATION", "PASSWORD_CHANGE", "PASSWORD_RESET", "PAYMENT", "GIFTCARD_BALANCE_CHECK", "LOYALTY_POINTS", "SEARCH", "ADD_TO_CART" ], "type": "string" }, "originUserIdCondition": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "stepSuccessConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`. This is allowed only for operations in a multistep group.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "successConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" } }, "required": [ "apiResourceId", "method", "operationName", "operationPurpose" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-operation.yaml" } }, "readOnly": true, "type": "array" } }, "required": [ "operations" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-operation-list.yaml" } } } }, "description": "Successful response." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You do not have the necessary access to perform this operation.", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/f1b952dbf3a940a9", "status": 403, "title": "Unauthorized Access/Action", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/UNAUTHORIZED" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the resource.", "x-akamai": { "file-path": "errors/403-error.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "endpoint 1234 version 10 does not exist.", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/c51861f1b4c908b9", "status": 404, "title": "Not Found", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The resource doesn't exist.", "x-akamai": { "file-path": "errors/404-version.yaml" } } }, "summary": "List resource operations", "tags": [ "Resource operations" ] }, "parameters": [ { "description": "Identifies an endpoint.", "example": "{{endpointId}}", "in": "path", "name": "endpointId", "required": true, "schema": { "example": 77653, "type": "integer" }, "x-akamai": { "file-path": "parameters/endpoint-id.yaml" } }, { "description": "The endpoint's version.", "example": "{{versionNumber}}", "in": "path", "name": "versionNumber", "required": true, "schema": { "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/version-number.yaml" } }, { "description": "Identifies a resource.", "example": "{{apiResourceId}}", "in": "path", "name": "apiResourceId", "required": true, "schema": { "example": 2143, "type": "integer" }, "x-akamai": { "file-path": "parameters/api-resource-id.yaml" } } ], "x-akamai": { "file-path": "paths/operations.yaml", "path-info": "/endpoints/{endpointId}/versions/{versionNumber}/resources/{apiResourceId}/operations" } }, "/endpoints/{endpointId}/versions/{versionNumber}/resources/{apiResourceId}/operations/{operationId}": { "get": { "description": "Get details about a specific resource operation.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-resource-operation" }, "operationId": "get-resource-operation", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "apiResourceId": 4102124, "conditions": [ { "apiParameterId": 3828246 } ], "method": "GET", "operationId": "e03cf501-b09b-49fa-b3c8-c3fa6787a359", "operationName": "login 1", "operationParameter": { "userEmail": { "parameterId": 1234567, "usedForLogin": true }, "userFirstName": { "parameterId": 1234567 }, "userLastName": { "parameterId": 1234567 }, "userOtherId": { "parameterId": 1234567, "usedForLogin": true }, "userPhoneNumber": { "parameterId": 1234567, "usedForLogin": true }, "username": { "parameterId": 1234567 } }, "operationPurpose": "LOGIN", "successConditions": [ { "positiveMatch": true, "type": "HTTP_STATUS", "values": [ "1" ] } ] }, "schema": { "additionalProperties": false, "description": "Collects data for resource operations.", "properties": { "apiResourceId": { "description": "Identifies the API resource.", "type": "integer" }, "conditions": { "description": "Specify the parameter values to match with.", "items": { "additionalProperties": false, "properties": { "apiParameterId": { "description": "Identifies the API parameter.", "type": "integer" }, "arrayIndexes": { "description": "Indexes for corresponding array parameters to find the data parameter.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "positiveMatch": { "description": "Indicates if the value matches the specified parameter value.", "nullable": true, "type": "boolean" }, "value": { "deprecated": true, "description": "__Deprecated__ The parameter value to match with.", "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "values": { "description": "The parameter values to match with.", "items": { "description": "A value to match on.", "minLength": 1, "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "apiParameterId" ], "type": "object" }, "nullable": true, "type": "array" }, "failureConditions": { "description": "Specify conditions to capture data on unsuccessful attempts to use the resource. You can set up failure reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "method": { "description": "HTTP method used to call the resource. Choose either `HEAD`, `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, or `OPTIONS`.", "enum": [ "HEAD", "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS" ], "type": "string" }, "multiFactorAuthentication": { "description": "Identifies multifactor authenticated operations. It's valid only for `PASSWORD_RESET` and `LOGIN` operations.", "nullable": true, "type": "boolean" }, "multistepGroupId": { "description": "Identifies the multistep group.", "nullable": true, "type": "string" }, "operationId": { "description": "__Read-only__ Identifies the operation.", "readOnly": true, "type": "string" }, "operationName": { "description": "The name of the operation. Use the same name you gave to the resource if you only specify one operation.", "minLength": 1, "type": "string" }, "operationParameter": { "additionalProperties": { "additionalProperties": false, "description": "Additional properties describing the parameter.", "properties": { "arrayIndexes": { "description": "Corresponding array parameters used to find data.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "parameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "referenceOperationId": { "description": "Identifies the referred operation.", "nullable": true, "type": "string" }, "referenceOperationLocation": { "description": "Identifies the operation parameter location of the referred operation, either `USERNAME`, `USER_EMAIL`, `USER_PHONE_NUMBER`, `USER_FIRST_NAME`, `USER_LAST_NAME`, or `USER_OTHER_ID`.", "enum": [ "USERNAME", "USER_EMAIL", "USER_PHONE_NUMBER", "USER_OTHER_ID", "USER_FIRST_NAME", "USER_LAST_NAME" ], "nullable": true, "type": "string" }, "usedForLogin": { "description": "Indicates if the parameter is used for login.", "nullable": true, "type": "boolean" } }, "type": "object" }, "description": "Collects data for operation parameters defined when the resource was created.", "nullable": true, "properties": { "userEmail": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userFirstName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userLastName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userOtherId": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userPhoneNumber": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "username": { "description": "If the `operationPurpose` supports a username, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource). Required for `LOGIN`, `ACCOUNT_VERIFICATION`, and `PASSWORD RESET`.", "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/operation-parameter.yaml" } }, "operationPurpose": { "description": "The task this operation serves. Choose either `LOGIN`, `ACCOUNT_UPDATE`, `ACCOUNT_VERIFICATION`, `ACCOUNT_CREATION`, `PASSWORD_CHANGE`, `PASSWORD_RESET`, `PAYMENT`, `GIFTCARD_BALANCE_CHECK`, `LOYALTY_POINTS`, `SEARCH`, or `ADD_TO_CART`. See [Operation purposes](https://techdocs.akamai.com/api-definitions/reference/operation-purposes) for details.", "enum": [ "LOGIN", "ACCOUNT_UPDATE", "ACCOUNT_VERIFICATION", "ACCOUNT_CREATION", "PASSWORD_CHANGE", "PASSWORD_RESET", "PAYMENT", "GIFTCARD_BALANCE_CHECK", "LOYALTY_POINTS", "SEARCH", "ADD_TO_CART" ], "type": "string" }, "originUserIdCondition": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "stepSuccessConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`. This is allowed only for operations in a multistep group.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "successConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" } }, "required": [ "apiResourceId", "method", "operationName", "operationPurpose" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-operation.yaml" } } } }, "description": "Successful response." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You do not have the necessary access to perform this operation.", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/f1b952dbf3a940a9", "status": 403, "title": "Unauthorized Access/Action", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/UNAUTHORIZED" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the resource.", "x-akamai": { "file-path": "errors/403-error.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource operation with id [1234] does not exist.", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/43667dca3dc2da02", "status": 404, "title": "Not Found", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The resource doesn't exist.", "x-akamai": { "file-path": "errors/404-resource.yaml" } } }, "summary": "Get a resource operation", "tags": [ "Resource operations" ] }, "put": { "description": "Update details about a resource operation. You can change the operation's name, method, purpose, and more.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/put-resource-operation" }, "operationId": "put-resource-operation", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "apiResourceId": 4102124, "conditions": [ { "apiParameterId": 3828246 } ], "method": "GET", "operationId": "e03cf501-b09b-49fa-b3c8-c3fa6787a359", "operationName": "login 1", "operationParameter": { "userEmail": { "parameterId": 1234567, "usedForLogin": true }, "userFirstName": { "parameterId": 1234567 }, "userLastName": { "parameterId": 1234567 }, "userOtherId": { "parameterId": 1234567, "usedForLogin": true }, "userPhoneNumber": { "parameterId": 1234567, "usedForLogin": true }, "username": { "parameterId": 1234567 } }, "operationPurpose": "LOGIN", "successConditions": [ { "positiveMatch": true, "type": "HTTP_STATUS", "values": [ "1" ] } ] }, "schema": { "additionalProperties": false, "description": "Collects data for resource operations.", "properties": { "apiResourceId": { "description": "Identifies the API resource.", "example": "{{apiResourceId}}", "type": "integer" }, "conditions": { "description": "Specify the parameter values to match with.", "items": { "additionalProperties": false, "properties": { "apiParameterId": { "description": "Identifies the API parameter.", "type": "integer" }, "arrayIndexes": { "description": "Indexes for corresponding array parameters to find the data parameter.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "positiveMatch": { "description": "Indicates if the value matches the specified parameter value.", "nullable": true, "type": "boolean" }, "value": { "deprecated": true, "description": "__Deprecated__ The parameter value to match with.", "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "values": { "description": "The parameter values to match with.", "items": { "description": "A value to match on.", "minLength": 1, "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "apiParameterId" ], "type": "object" }, "nullable": true, "type": "array" }, "failureConditions": { "description": "Specify conditions to capture data on unsuccessful attempts to use the resource. You can set up failure reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "method": { "description": "HTTP method used to call the resource. Choose either `HEAD`, `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, or `OPTIONS`.", "enum": [ "HEAD", "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS" ], "example": "{{method}}", "type": "string" }, "multiFactorAuthentication": { "description": "Identifies multifactor authenticated operations. It's valid only for `PASSWORD_RESET` and `LOGIN` operations.", "example": "{{multiFactorAuthentication}}", "nullable": true, "type": "boolean" }, "multistepGroupId": { "description": "Identifies the multistep group.", "example": "{{multistepGroupId}}", "nullable": true, "type": "string" }, "operationId": { "description": "__Read-only__ Identifies the operation.", "example": "{{operationId}}", "readOnly": true, "type": "string" }, "operationName": { "description": "The name of the operation. Use the same name you gave to the resource if you only specify one operation.", "example": "{{operationName}}", "minLength": 1, "type": "string" }, "operationParameter": { "additionalProperties": { "additionalProperties": false, "description": "Additional properties describing the parameter.", "properties": { "arrayIndexes": { "description": "Corresponding array parameters used to find data.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "parameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "referenceOperationId": { "description": "Identifies the referred operation.", "nullable": true, "type": "string" }, "referenceOperationLocation": { "description": "Identifies the operation parameter location of the referred operation, either `USERNAME`, `USER_EMAIL`, `USER_PHONE_NUMBER`, `USER_FIRST_NAME`, `USER_LAST_NAME`, or `USER_OTHER_ID`.", "enum": [ "USERNAME", "USER_EMAIL", "USER_PHONE_NUMBER", "USER_OTHER_ID", "USER_FIRST_NAME", "USER_LAST_NAME" ], "nullable": true, "type": "string" }, "usedForLogin": { "description": "Indicates if the parameter is used for login.", "nullable": true, "type": "boolean" } }, "type": "object" }, "description": "Collects data for operation parameters defined when the resource was created.", "nullable": true, "properties": { "userEmail": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userFirstName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userLastName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userOtherId": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userPhoneNumber": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "username": { "description": "If the `operationPurpose` supports a username, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource). Required for `LOGIN`, `ACCOUNT_VERIFICATION`, and `PASSWORD RESET`.", "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/operation-parameter.yaml" } }, "operationPurpose": { "description": "The task this operation serves. Choose either `LOGIN`, `ACCOUNT_UPDATE`, `ACCOUNT_VERIFICATION`, `ACCOUNT_CREATION`, `PASSWORD_CHANGE`, `PASSWORD_RESET`, `PAYMENT`, `GIFTCARD_BALANCE_CHECK`, `LOYALTY_POINTS`, `SEARCH`, or `ADD_TO_CART`. See [Operation purposes](https://techdocs.akamai.com/api-definitions/reference/operation-purposes) for details.", "enum": [ "LOGIN", "ACCOUNT_UPDATE", "ACCOUNT_VERIFICATION", "ACCOUNT_CREATION", "PASSWORD_CHANGE", "PASSWORD_RESET", "PAYMENT", "GIFTCARD_BALANCE_CHECK", "LOYALTY_POINTS", "SEARCH", "ADD_TO_CART" ], "example": "{{operationPurpose}}", "type": "string" }, "originUserIdCondition": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "stepSuccessConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`. This is allowed only for operations in a multistep group.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "successConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" } }, "required": [ "apiResourceId", "method", "operationName", "operationPurpose" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-operation.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "apiResourceId": 4102124, "conditions": [ { "apiParameterId": 3828246 } ], "method": "GET", "operationId": "e03cf501-b09b-49fa-b3c8-c3fa6787a359", "operationName": "login 1", "operationParameter": { "userEmail": { "parameterId": 1234567, "usedForLogin": true }, "userFirstName": { "parameterId": 1234567 }, "userLastName": { "parameterId": 1234567 }, "userOtherId": { "parameterId": 1234567, "usedForLogin": true }, "userPhoneNumber": { "parameterId": 1234567, "usedForLogin": true }, "username": { "parameterId": 1234567 } }, "operationPurpose": "LOGIN", "successConditions": [ { "positiveMatch": true, "type": "HTTP_STATUS", "values": [ "1" ] } ] }, "schema": { "additionalProperties": false, "description": "Collects data for resource operations.", "properties": { "apiResourceId": { "description": "Identifies the API resource.", "type": "integer" }, "conditions": { "description": "Specify the parameter values to match with.", "items": { "additionalProperties": false, "properties": { "apiParameterId": { "description": "Identifies the API parameter.", "type": "integer" }, "arrayIndexes": { "description": "Indexes for corresponding array parameters to find the data parameter.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "positiveMatch": { "description": "Indicates if the value matches the specified parameter value.", "nullable": true, "type": "boolean" }, "value": { "deprecated": true, "description": "__Deprecated__ The parameter value to match with.", "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "values": { "description": "The parameter values to match with.", "items": { "description": "A value to match on.", "minLength": 1, "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "apiParameterId" ], "type": "object" }, "nullable": true, "type": "array" }, "failureConditions": { "description": "Specify conditions to capture data on unsuccessful attempts to use the resource. You can set up failure reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "method": { "description": "HTTP method used to call the resource. Choose either `HEAD`, `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, or `OPTIONS`.", "enum": [ "HEAD", "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS" ], "type": "string" }, "multiFactorAuthentication": { "description": "Identifies multifactor authenticated operations. It's valid only for `PASSWORD_RESET` and `LOGIN` operations.", "nullable": true, "type": "boolean" }, "multistepGroupId": { "description": "Identifies the multistep group.", "nullable": true, "type": "string" }, "operationId": { "description": "__Read-only__ Identifies the operation.", "readOnly": true, "type": "string" }, "operationName": { "description": "The name of the operation. Use the same name you gave to the resource if you only specify one operation.", "minLength": 1, "type": "string" }, "operationParameter": { "additionalProperties": { "additionalProperties": false, "description": "Additional properties describing the parameter.", "properties": { "arrayIndexes": { "description": "Corresponding array parameters used to find data.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "parameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "referenceOperationId": { "description": "Identifies the referred operation.", "nullable": true, "type": "string" }, "referenceOperationLocation": { "description": "Identifies the operation parameter location of the referred operation, either `USERNAME`, `USER_EMAIL`, `USER_PHONE_NUMBER`, `USER_FIRST_NAME`, `USER_LAST_NAME`, or `USER_OTHER_ID`.", "enum": [ "USERNAME", "USER_EMAIL", "USER_PHONE_NUMBER", "USER_OTHER_ID", "USER_FIRST_NAME", "USER_LAST_NAME" ], "nullable": true, "type": "string" }, "usedForLogin": { "description": "Indicates if the parameter is used for login.", "nullable": true, "type": "boolean" } }, "type": "object" }, "description": "Collects data for operation parameters defined when the resource was created.", "nullable": true, "properties": { "userEmail": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userFirstName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userLastName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userOtherId": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userPhoneNumber": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "username": { "description": "If the `operationPurpose` supports a username, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource). Required for `LOGIN`, `ACCOUNT_VERIFICATION`, and `PASSWORD RESET`.", "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/operation-parameter.yaml" } }, "operationPurpose": { "description": "The task this operation serves. Choose either `LOGIN`, `ACCOUNT_UPDATE`, `ACCOUNT_VERIFICATION`, `ACCOUNT_CREATION`, `PASSWORD_CHANGE`, `PASSWORD_RESET`, `PAYMENT`, `GIFTCARD_BALANCE_CHECK`, `LOYALTY_POINTS`, `SEARCH`, or `ADD_TO_CART`. See [Operation purposes](https://techdocs.akamai.com/api-definitions/reference/operation-purposes) for details.", "enum": [ "LOGIN", "ACCOUNT_UPDATE", "ACCOUNT_VERIFICATION", "ACCOUNT_CREATION", "PASSWORD_CHANGE", "PASSWORD_RESET", "PAYMENT", "GIFTCARD_BALANCE_CHECK", "LOYALTY_POINTS", "SEARCH", "ADD_TO_CART" ], "type": "string" }, "originUserIdCondition": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "stepSuccessConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`. This is allowed only for operations in a multistep group.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "successConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" } }, "required": [ "apiResourceId", "method", "operationName", "operationPurpose" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-operation.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "#/sensitivity: must have a minimum value of 1", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d13f9326b05ca37d", "status": 400, "title": "Invalid Input Error", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/INVALID-INPUT-ERROR" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). The request body has invalid fields.", "x-akamai": { "file-path": "errors/400-resource.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the resource.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource operation with id [1234] does not exist.", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/43667dca3dc2da02", "status": 404, "title": "Not Found", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The requested resource operation doesn't exist.", "x-akamai": { "file-path": "errors/404-resource.yaml" } } }, "summary": "Update a resource operation", "tags": [ "Resource operations" ] }, "delete": { "description": "Remove a specific resource operation.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/delete-resource-operation" }, "operationId": "delete-resource-operation", "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" } } ], "responses": { "204": { "content": {}, "description": "Successful response." }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "2602aedd-38a9-41c3-a607-8a6ad8129e6b", "status": 403, "title": "Forbidden", "type": "/api-definitions/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Contains debugging information for error responses.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Nested error responses.", "items": { "description": "A further nested problem detail object.", "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details-recurse.yaml" } }, "type": "array" }, "instance": { "description": "The non-referenceable URL for the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/http-problem-details.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/api-definitions/reference/403). You don't have permission to access the resource.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource operation with id [1234] does not exist.", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/43667dca3dc2da02", "status": 404, "title": "Not Found", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/api-definitions/reference/404). The requested resource operation doesn't exist.", "x-akamai": { "file-path": "errors/404-resource.yaml" } } }, "summary": "Delete a resource operation", "tags": [ "Resource operations" ] }, "parameters": [ { "description": "Identifies an endpoint.", "example": "{{endpointId}}", "in": "path", "name": "endpointId", "required": true, "schema": { "example": 77653, "type": "integer" }, "x-akamai": { "file-path": "parameters/endpoint-id.yaml" } }, { "description": "The endpoint's version.", "example": "{{versionNumber}}", "in": "path", "name": "versionNumber", "required": true, "schema": { "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/version-number.yaml" } }, { "description": "Identifies a resource.", "example": "{{apiResourceId}}", "in": "path", "name": "apiResourceId", "required": true, "schema": { "example": 2143, "type": "integer" }, "x-akamai": { "file-path": "parameters/api-resource-id.yaml" } }, { "description": "Identifies an operation.", "example": "{{operationId}}", "in": "path", "name": "operationId", "required": true, "schema": { "example": "123e4567-e89b-12d3-a456-426614174000", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "type": "string" }, "x-akamai": { "file-path": "parameters/operation-id.yaml" } } ], "x-akamai": { "file-path": "paths/operation.yaml", "path-info": "/endpoints/{endpointId}/versions/{versionNumber}/resources/{apiResourceId}/operations/{operationId}" } }, "/search-operations": { "post": { "description": "Get a filtered list of operations and their endpoints and resources. You can filter by date ranges, activation statuses, API Endpoint hostnames, and resource paths. For a simpler search, run [Search operations](https://techdocs.akamai.com/api-definitions/reference/get-search-operations).", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/post-search-operation" }, "operationId": "post-search-operation", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "activeEndTime": "2022-01-02T00:00:00Z", "activeStartTime": "2022-01-01T00:00:00Z", "apiEndPointHosts": [ "*.example.com" ], "queryType": "ACTIVE_WITHIN_DATE_RANGE", "resourcePaths": [ "/test-path/*" ] }, "schema": { "additionalProperties": false, "description": "Collects data used for generating operations reports filtered based on the specified criteria.", "properties": { "activeEndTime": { "description": "If the `queryType` is `ACTIVE_WITHIN_DATE_RANGE`, specify the ISO 8601 timestamp for the end of the date range. Specify `null` to use the current time.", "example": "{{activeEndTime}}", "minLength": 1, "nullable": true, "type": "string" }, "activeStartTime": { "description": "If the `queryType` is `ACTIVE_WITHIN_DATE_RANGE`, specify the ISO 8601 timestamp for the start of the date range.", "example": "{{activeStartTime}}", "minLength": 1, "nullable": true, "type": "string" }, "apiEndPointHosts": { "description": "Specify a list of API endpoint hostnames to filter on. Users access the Akamai-deployed API using these hostnames.", "items": { "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "includeDetails": { "description": "Specify `true` to include all the resource and operation details.", "example": "{{includeDetails}}", "nullable": true, "type": "boolean" }, "queryType": { "description": "Filter the results for an operation report. Choose `ACTIVE_IN_PRODUCTION`, `ACTIVE_IN_STAGING`, or `ACTIVE_WITHIN_DATE_RANGE`.", "enum": [ "ACTIVE_IN_PRODUCTION", "ACTIVE_IN_STAGING", "ACTIVE_WITHIN_DATE_RANGE" ], "example": "{{queryType}}", "type": "string" }, "resourcePaths": { "description": "Specify the URL paths relative to the hostnames on which the resource resides. The path is the hostname, followed by the base path. 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` field in the corresponding parameter definition matches the name that you specified in the resource path.", "items": { "minLength": 1, "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "queryType" ], "type": "object", "x-akamai": { "file-path": "schemas/operations-search.yaml" } } } } }, "responses": { "200": { "content": { "application/json": { "example": { "apiEndPoints": [ { "apiEndPointHosts": [ "www.bot-staging.net", "www.botman-test1.com", "www.botman-test.com", "www.test-login.com" ], "apiEndPointId": 503130, "apiEndPointName": "E2ETest", "basePath": "/login", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/503130/versions/4", "productionVersion": { "status": "ACTIVE", "timestamp": "2019-10-02T16:04:14+0000", "versionNumber": 4 }, "stagingVersion": { "status": "ACTIVE", "timestamp": "2019-10-02T15:59:07+0000", "versionNumber": 4 } }, { "apiEndPointHosts": [ "www.staging-activated.com" ], "apiEndPointId": 464125, "apiEndPointName": "Activated", "basePath": "/staging", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/464125/versions/2", "productionVersion": {}, "stagingVersion": { "status": "ACTIVE", "timestamp": "2020-03-04T15:28:25+0000", "versionNumber": 2 } }, { "apiEndPointHosts": [ "*.vtest.com", "www.test.com" ], "apiEndPointId": 502216, "apiEndPointName": "Account protections", "basePath": "/webinline", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/502216/versions/2", "productionVersion": {}, "stagingVersion": { "status": "ACTIVE", "timestamp": "2019-09-24T03:03:05+0000", "versionNumber": 2 } }, { "apiEndPointHosts": [ "test.tony.com" ], "apiEndPointId": 291184, "apiEndPointName": "test", "basePath": "/", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/291184/versions/2", "productionVersion": { "status": "ACTIVE", "timestamp": "2018-07-06T16:06:19+0000", "versionNumber": 1 }, "stagingVersion": { "status": "ACTIVE", "timestamp": "2019-04-09T03:39:18+0000", "versionNumber": 2 } } ], "operations": [ { "apiEndPointId": 503130, "apiResourceId": 3143802, "apiResourceLogicId": 122202, "conditions": [ { "apiParameterId": 1636906, "value": "cors/form-login" } ], "link": "/api-definitions/v2/endpoints/503130/versions/4/resources/3143802/operations/123a567b-fe5c-4d52-9cc9-a9cd870f0829", "metadata": { "isActive": true }, "method": "POST", "operationId": "123a567b-fe5c-4d52-9cc9-a9cd870f0829", "operationName": "Form Data", "operationPurpose": "ACCOUNT_VERIFICATION" }, { "apiEndPointId": 493213, "apiResourceId": 3055228, "apiResourceLogicId": 118374, "link": "/api-definitions/v2/endpoints/493213/versions/1/resources/3055228/operations/123a567b-5f82-44e8-95cd-cdcff189a1f2", "metadata": { "isActive": true }, "method": "GET", "operationId": "123a567b-5f82-44e8-95cd-cdcff189a1f2", "operationName": "ProtectedPurpose2", "operationPurpose": "LOYALTY_POINTS" }, { "apiEndPointId": 464125, "apiResourceId": 3545852, "apiResourceLogicId": 106953, "link": "/api-definitions/v2/endpoints/464125/versions/2/resources/3545852/operations/ea603927-99a6-4c25-bd18-b51db7bbff25", "metadata": { "isActive": true }, "method": "GET", "operationId": "ea603927-99a6-4c25-bd18-b51db7bbff25", "operationName": "Purpose1", "operationPurpose": "ACCOUNT_VERIFICATION" }, { "apiEndPointId": 291184, "apiResourceId": 1234567, "apiResourceLogicId": 11737, "conditions": [ { "apiParameterId": 1014208 } ], "link": "/api-definitions/v2/endpoints/291184/versions/2/resources/1234567/operations/c00009d1-64bb-49e5-a492-a81e9aeed1b7", "metadata": { "isActive": true }, "method": "POST", "operationId": "c00009d1-64bb-49e5-a492-a81e9aeed1b7", "operationName": "login", "operationParameter": { "username": { "parameterId": 1014209, "usedForLogin": null } }, "operationPurpose": "LOGIN" } ], "resources": [ { "apiEndPointId": 503130, "apiResourceId": 3143802, "apiResourceLogicId": 122202, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 778229, "apiParameterId": 1636906, "apiParameterLocation": "query", "apiParameterName": "route", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 572570, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 365993, "apiResourceMethodLogicId": 170106, "methodRestrictions": null } ], "apiResourceName": "Login Form Data", "createDate": "2019-10-02T15:39:03+0000", "createdBy": "jsmith", "link": "/api-definitions/v2/endpoints/503130/versions/4/resources/3143802", "lockVersion": 0, "metadata": { "methodsEnabled": 1, "methodsWithOperations": 1, "operationCount": 3 }, "resourcePath": "/index.php", "updateDate": "2019-10-02T15:39:03+0000", "updatedBy": "jsmith" }, { "apiEndPointId": 463140, "apiResourceId": 3545900, "apiResourceLogicId": 106954, "apiResourceMethods": [ { "apiParameters": [], "apiResourceMethod": "POST", "apiResourceMethodId": 474030, "apiResourceMethodLogicId": 147694, "methodRestrictions": null }, { "apiParameters": [], "apiResourceMethod": "GET", "apiResourceMethodId": 474029, "apiResourceMethodLogicId": 147693, "methodRestrictions": null } ], "apiResourceName": "Resource1", "createDate": "2020-03-04T15:24:36+0000", "createdBy": "mrossi", "link": "/api-definitions/v2/endpoints/463140/versions/4/resources/3545900", "lockVersion": 0, "metadata": { "methodsEnabled": 2, "methodsWithOperations": 1, "operationCount": 1 }, "resourcePath": "/index.php", "updateDate": "2020-03-04T15:24:36+0000", "updatedBy": "afero" }, { "apiEndPointId": 464125, "apiResourceId": 3545852, "apiResourceLogicId": 106953, "apiResourceMethods": [ { "apiParameters": [], "apiResourceMethod": "GET", "apiResourceMethodId": 474019, "apiResourceMethodLogicId": 147691, "methodRestrictions": null }, { "apiParameters": [], "apiResourceMethod": "POST", "apiResourceMethodId": 474020, "apiResourceMethodLogicId": 147692, "methodRestrictions": null } ], "apiResourceName": "Resource1", "createDate": "2020-03-04T15:23:59+0000", "createdBy": "jdupont", "link": "/api-definitions/v2/endpoints/464125/versions/2/resources/3545852", "lockVersion": 0, "metadata": { "methodsEnabled": 2, "methodsWithOperations": 1, "operationCount": 1 }, "resourcePath": "/index.php", "updateDate": "2020-03-04T15:23:59+0000", "updatedBy": "szhang" }, { "apiEndPointId": 291184, "apiResourceId": 1234567, "apiResourceLogicId": 11737, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [ { "apiChildParameters": [], "apiParamLogicId": 56167, "apiParameterId": 1014208, "apiParameterLocation": "body", "apiParameterName": "j_password", "apiParameterNotes": null, "apiParameterRequired": false, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": null, "array": false, "pathParamLocationId": null, "response": false }, { "apiChildParameters": [], "apiParamLogicId": 56168, "apiParameterId": 1014209, "apiParameterLocation": "body", "apiParameterName": "j_username", "apiParameterNotes": null, "apiParameterRequired": false, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": null, "array": false, "pathParamLocationId": null, "response": false } ], "apiParamLogicId": 56166, "apiParameterId": 1014207, "apiParameterLocation": "body", "apiParameterName": "root", "apiParameterNotes": null, "apiParameterRequired": false, "apiParameterRestriction": null, "apiParameterType": "json/xml", "apiResourceMethParamId": 412851, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 268261, "apiResourceMethodLogicId": 15869, "methodRestrictions": null } ], "apiResourceName": "test", "createDate": "2019-04-09T03:01:10+0000", "createdBy": "mrossi", "link": "/api-definitions/v2/endpoints/291184/versions/2/resources/1234567", "lockVersion": 0, "metadata": { "methodsEnabled": 1, "methodsWithOperations": 1, "operationCount": 1 }, "resourcePath": "/base", "updateDate": "2019-04-09T03:01:10+0000", "updatedBy": "jdupont" } ] }, "schema": { "additionalProperties": false, "description": "Collects data for the operation report.", "properties": { "apiEndPoints": { "description": "API endpoints and their data.", "items": { "additionalProperties": false, "description": "Collects data about an API endpoint.", "properties": { "apiEndPointHosts": { "description": "API endpoint hostnames.", "items": { "description": "A hostname used to publish the API through Akamai.", "minLength": 1, "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "Identifies the API endpoint.", "type": "integer" }, "apiEndPointName": { "description": "The name of the API endpoint.", "minLength": 1, "type": "string" }, "basePath": { "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` field in the corresponding parameter definition matches the name that you specified in the resource path.", "minLength": 1, "type": "string" }, "caseSensitive": { "description": "Whether to match on case sensitivity.", "type": "boolean" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "minLength": 1, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "Collects data about the API endpoint's activation status.", "properties": { "status": { "description": "The activation status, either `PENDING` if the version contains changes that are being propagated, `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.", "minLength": 1, "nullable": true, "type": "string" }, "timestamp": { "description": "The ISO 8601 timestamp indicating when the activation status was last updated.", "minLength": 1, "nullable": true, "type": "string" }, "versionNumber": { "description": "The endpoint's version.", "nullable": true, "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/activation-status.yaml" } }, "stagingVersion": { "additionalProperties": false, "description": "Collects data about the API endpoint's activation status.", "properties": { "status": { "description": "The activation status, either `PENDING` if the version contains changes that are being propagated, `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.", "minLength": 1, "nullable": true, "type": "string" }, "timestamp": { "description": "The ISO 8601 timestamp indicating when the activation status was last updated.", "minLength": 1, "nullable": true, "type": "string" }, "versionNumber": { "description": "The endpoint's version.", "nullable": true, "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/activation-status.yaml" } } }, "required": [ "apiEndPointId", "apiEndPointHosts", "apiEndPointName", "basePath", "caseSensitive", "link" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-summary.yaml" } }, "type": "array" }, "operations": { "description": "Operations and their data.", "items": { "additionalProperties": false, "description": "Collects data for an operation.", "properties": { "apiEndPointId": { "description": "Identifies the API endpoint.", "type": "integer" }, "apiResourceId": { "description": "Identifies the API resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "conditions": { "description": "Specify the parameter values to match with.", "items": { "additionalProperties": false, "properties": { "apiParameterId": { "description": "Identifies the API parameter.", "type": "integer" }, "value": { "description": "The parameter value to match with.", "nullable": true, "type": "string" } }, "required": [ "apiParameterId" ], "type": "object" }, "nullable": true, "type": "array" }, "failureConditions": { "description": "Specify conditions to capture data on unsuccessful attempts to use the resource. You can set up failure reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "minLength": 1, "type": "string" }, "metadata": { "additionalProperties": false, "description": "Additional information about the operation.", "nullable": true, "properties": { "isActive": { "description": "Informs you if the operation is currently active in production or staging.", "type": "boolean" } }, "type": "object" }, "method": { "description": "The HTTP method used in combination with the resource. Choose between `HEAD`, `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, or `OPTIONS`.", "enum": [ "HEAD", "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS" ], "type": "string" }, "multistepGroupId": { "description": "__Read-only__ Identifies the multistep group for the operation.", "readOnly": true, "type": "string" }, "multistepGroupName": { "description": "__Read-only__ Identifies the multistep group name.", "readOnly": true, "type": "string" }, "operationId": { "description": "__Read-only__ Identifies the operation.", "readOnly": true, "type": "string" }, "operationName": { "description": "The name of the operation. Use the same name you gave to the resource if you only specify one operation.", "minLength": 1, "type": "string" }, "operationParameter": { "additionalProperties": { "additionalProperties": false, "description": "Additional properties describing the parameter.", "properties": { "arrayIndexes": { "description": "Corresponding array parameters used to find data.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "parameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "referenceOperationId": { "description": "Identifies the referred operation.", "nullable": true, "type": "string" }, "referenceOperationLocation": { "description": "Identifies the operation parameter location of the referred operation, either `USERNAME`, `USER_EMAIL`, `USER_PHONE_NUMBER`, `USER_FIRST_NAME`, `USER_LAST_NAME`, or `USER_OTHER_ID`.", "enum": [ "USERNAME", "USER_EMAIL", "USER_PHONE_NUMBER", "USER_OTHER_ID", "USER_FIRST_NAME", "USER_LAST_NAME" ], "nullable": true, "type": "string" }, "usedForLogin": { "description": "Indicates if the parameter is used for login.", "nullable": true, "type": "boolean" } }, "type": "object" }, "description": "Collects data for operation parameters defined when the resource was created.", "nullable": true, "properties": { "userEmail": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userFirstName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userLastName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userOtherId": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userPhoneNumber": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "username": { "description": "If the `operationPurpose` supports a username, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource). Required for `LOGIN`, `ACCOUNT_VERIFICATION`, and `PASSWORD RESET`.", "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/operation-parameter.yaml" } }, "operationPurpose": { "description": "The task this operation serves. Choose between `LOGIN`, `ACCOUNT_VERIFICATION`, `ACCOUNT_CREATION`, `ACCOUNT_UPDATE`, `PASSWORD_RESET`, `PASSWORD_CHANGE`, `PAYMENT`, `GIFTCARD_BALANCE_CHECK`, `LOYALTY_POINTS`, `SEARCH`, `ADD_TO_CART`, or `OTHER`.", "enum": [ "LOGIN", "ACCOUNT_VERIFICATION", "ACCOUNT_CREATION", "ACCOUNT_UPDATE", "PASSWORD_RESET", "PASSWORD_CHANGE", "PAYMENT", "GIFTCARD_BALANCE_CHECK", "LOYALTY_POINTS", "SEARCH", "ADD_TO_CART", "OTHER" ], "type": "string" }, "originUserIdCondition": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "successConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" } }, "required": [ "apiEndPointId", "apiResourceId", "apiResourceLogicId", "link", "operationId", "operationName", "operationPurpose", "method" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-summary.yaml" } }, "type": "array" }, "resources": { "description": "Resources and their data.", "items": { "additionalProperties": false, "description": "Collects data about a resource.", "properties": { "apiEndPointId": { "description": "Identifies the API endpoint.", "type": "integer" }, "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "Identifies the API resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethods": { "description": "Method objects that represent HTTP methods the resource may respond to.", "items": { "additionalProperties": false, "description": "An HTTP method to which a resource may respond.", "properties": { "apiParameters": { "description": "Parameter objects associated with the method.", "items": { "additionalProperties": false, "description": "An HTTP method to which a resource may respond.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A nested API parameter object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameters-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "The unique identifier for the parameter.", "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "body", "header", "path", "cookie" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "Optional notes describing the parameter's function. If you specify an empty string in the request or omit this field from the object, the JSON response reflects it as `null`.", "nullable": true, "type": "string" }, "apiParameterRequired": { "description": "Whether the parameter is needed. If the corresponding `apiParameterLocation` is `path`, set this field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Specify restrictions and XML representation rules for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "If you enabled an `array` field, specify restrictions on array parameters.", "nullable": true, "properties": { "collectionFormat": { "description": "The format of the array that specifies how you separated array values. Choose 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 multiple parameter instances.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "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 unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Specify length restrictions for string parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Specify range restrictions on number parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "type": "integer" }, "numberRangeMin": { "description": "The minimum range restriction.", "type": "integer" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Specify range restrictions for integer parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "The maximum allowed size of the response body.", "nullable": true, "properties": { "maxBodySize": { "description": "Specify the size limit of the response body. Choose `SIZE_6K` for 6KB, `SIZE_8K` for 8KB, `SIZE_12K` for 12KB, or `NO_LIMIT` to allow any response size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "Response status codes to be matched to the response. Specify `null` or leave empty to apply the definition to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "XML settings for the parameter.", "nullable": true, "properties": { "attribute": { "description": "Whether the parameter should be represented as an attribute.", "nullable": true, "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified when you created the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "nullable": true, "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "nullable": true, "type": "string" }, "wrapped": { "description": "Whether the parameter should be wrapped in a parent XML element.", "nullable": true, "type": "boolean" } }, "type": "object" } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean` for cookies, headers, query string, and path parameters. For request body following types are supported: `json`, `xml`, or `json/xml` for either JSON or XML objects, or `urlencoded`.", "enum": [ "string", "integer", "number", "boolean", "json/xml", "json", "xml", "urlencoded" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter belongs to the response.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameters.yaml" } }, "type": "array" }, "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "DELETE", "GET", "PATCH", "PUT", "POST", "OPTIONS", "HEAD" ], "type": "string" }, "apiResourceMethodId": { "description": "The unique identifier for the resource's allowed method.", "type": "integer" }, "apiResourceMethodLogicId": { "description": "The unique identifier for the resource's method across all endpoint versions.", "type": "integer" }, "methodRestrictions": { "additionalProperties": false, "description": "Collects data for restrictions on the method level.", "nullable": true, "properties": { "allowMethodUndefinedParameters": { "additionalProperties": false, "description": "Specify whether undefined parameters are allowed, overriding the top-level setting for undefined parameters.", "properties": { "body": { "description": "Whether undefined parameters are allowed in request body.", "type": "boolean" }, "cookie": { "description": "Whether undefined parameters are allowed in request cookies.", "type": "boolean" }, "header": { "description": "Whether undefined parameters are allowed in request headers.", "type": "boolean" }, "query": { "description": "Whether undefined parameters are allowed in request query string.", "type": "boolean" } }, "required": [ "header", "cookie", "query", "body" ], "type": "object" }, "jsonRequestRejectDuplicates": { "description": "Whether to reject duplicate JSON requests.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/method-restrictions.yaml" } } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-methods.yaml" } }, "nullable": true, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "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 field from the object, the JSON response reflects it as an empty string.", "minLength": 1, "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients. Don't include hostnames.", "minLength": 1, "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](#concurrencycontrol) for details.", "type": "integer" }, "metadata": { "additionalProperties": false, "description": "Information about the number of methods enabled, methods with assigned operations, and operations.", "nullable": true, "properties": { "methodsEnabled": { "description": "The number of methods enabled for the resource.", "type": "integer" }, "methodsWithOperations": { "description": "The number of methods that have assigned operations.", "type": "integer" }, "operationCount": { "description": "The total number of operations assigned to the resource.", "type": "integer" } }, "required": [ "methodsEnabled", "methodsWithOperations", "operationCount" ], "type": "object" }, "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 resource's path, with the API base path omitted. For example, `/login`.", "minLength": 1, "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiEndPointId", "apiResourceId", "apiResourceLogicId", "apiResourceName", "link", "metadata", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-summary.yaml" } }, "type": "array" }, "validation": { "additionalProperties": false, "description": "Contains warnings, errors, or notices determined by validating the match target.", "properties": { "errors": { "description": "__Read-only__ Errors.", "items": { "additionalProperties": false, "description": "Contains feedback on validation.", "properties": { "detail": { "description": "The explanation of the error message.", "type": "string" }, "fieldName": { "description": "The name of the field causing the validation problem.", "type": "string" }, "jsonReference": { "description": "The JSON reference to the field in the resource.", "type": "string" }, "operationId": { "description": "Identifies the operation.", "nullable": true, "type": "string" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "title", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/validation-dto.yaml" } }, "readOnly": true, "type": "array" }, "notices": { "description": "__Read-only__ Notices.", "items": { "additionalProperties": false, "description": "Contains feedback on validation.", "properties": { "detail": { "description": "The explanation of the error message.", "type": "string" }, "fieldName": { "description": "The name of the field causing the validation problem.", "type": "string" }, "jsonReference": { "description": "The JSON reference to the field in the resource.", "type": "string" }, "operationId": { "description": "Identifies the operation.", "nullable": true, "type": "string" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "title", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/validation-dto.yaml" } }, "readOnly": true, "type": "array" }, "warnings": { "description": "__Read-only__ Warnings.", "items": { "additionalProperties": false, "description": "Contains feedback on validation.", "properties": { "detail": { "description": "The explanation of the error message.", "type": "string" }, "fieldName": { "description": "The name of the field causing the validation problem.", "type": "string" }, "jsonReference": { "description": "The JSON reference to the field in the resource.", "type": "string" }, "operationId": { "description": "Identifies the operation.", "nullable": true, "type": "string" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "title", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/validation-dto.yaml" } }, "readOnly": true, "type": "array" } }, "required": [ "notices", "errors", "warnings" ], "type": "object", "x-akamai": { "file-path": "schemas/validation.yaml" } } }, "required": [ "apiEndPoints", "operations", "resources" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-report.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "#/sensitivity: must have a minimum value of 1", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d13f9326b05ca37d", "status": 400, "title": "Invalid Input Error", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/INVALID-INPUT-ERROR" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). The request body has invalid fields.", "x-akamai": { "file-path": "errors/400-resource.yaml" } } }, "summary": "Query operations", "tags": [ "Filter operations" ] }, "get": { "description": "Get a filtered list of operations and their endpoints and resources. Use `queryType` to filter by date ranges or activation statuses. For more complex queries, run [Query operations](https://techdocs.akamai.com/api-definitions/reference/post-search-operation).", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/get-search-operations" }, "operationId": "get-search-operations", "parameters": [ { "description": "__Enum__ Choose `ACTIVE_IN_PRODUCTION`, `ACTIVE_IN_STAGING`, or `ACTIVE_WITHIN_DATE_RANGE`.", "example": "{{queryType}}", "in": "query", "name": "queryType", "required": false, "schema": { "enum": [ "ACTIVE_IN_PRODUCTION", "ACTIVE_IN_STAGING", "ACTIVE_WITHIN_DATE_RANGE" ], "example": "ACTIVE_WITHIN_DATE_RANGE", "type": "string" }, "x-akamai": { "file-path": "parameters/query-type-query.yaml" } }, { "description": "The ISO 8601 timestamp for the start of the date range.", "example": "{{activeStartTime}}", "in": "query", "name": "activeStartTime", "required": false, "schema": { "example": "2023-05-13T19:30:24+0000", "type": "string" }, "x-akamai": { "file-path": "parameters/active-start-time-query.yaml" } }, { "description": "The ISO 8601 timestamp for the end of the date range.", "example": "{{activeEndTime}}", "in": "query", "name": "activeEndTime", "required": false, "schema": { "example": "2023-05-14T19:30:24+0000", "type": "string" }, "x-akamai": { "file-path": "parameters/active-end-time-query.yaml" } }, { "description": "Includes all the resource and operation details, `false` by default.", "example": "{{includeDetails}}", "in": "query", "name": "includeDetails", "required": false, "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/include-details-query.yaml" } }, { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "apiEndPoints": [ { "apiEndPointHosts": [ "www.bot-staging.net", "www.botman-test1.com", "www.botman-test.com", "www.test-login.com" ], "apiEndPointId": 503130, "apiEndPointName": "E2ETest", "basePath": "/login", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/503130/versions/4", "productionVersion": { "status": "ACTIVE", "timestamp": "2019-10-02T16:04:14+0000", "versionNumber": 4 }, "stagingVersion": { "status": "ACTIVE", "timestamp": "2019-10-02T15:59:07+0000", "versionNumber": 4 } }, { "apiEndPointHosts": [ "www.staging-activated.com" ], "apiEndPointId": 464125, "apiEndPointName": "Activated", "basePath": "/staging", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/464125/versions/2", "productionVersion": {}, "stagingVersion": { "status": "ACTIVE", "timestamp": "2020-03-04T15:28:25+0000", "versionNumber": 2 } }, { "apiEndPointHosts": [ "*.vtest.com", "www.test.com" ], "apiEndPointId": 502216, "apiEndPointName": "Account protections", "basePath": "/webinline", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/502216/versions/2", "productionVersion": {}, "stagingVersion": { "status": "ACTIVE", "timestamp": "2019-09-24T03:03:05+0000", "versionNumber": 2 } }, { "apiEndPointHosts": [ "test.tony.com" ], "apiEndPointId": 291184, "apiEndPointName": "test", "basePath": "/", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/291184/versions/2", "productionVersion": { "status": "ACTIVE", "timestamp": "2018-07-06T16:06:19+0000", "versionNumber": 1 }, "stagingVersion": { "status": "ACTIVE", "timestamp": "2019-04-09T03:39:18+0000", "versionNumber": 2 } } ], "operations": [ { "apiEndPointId": 503130, "apiResourceId": 3143802, "apiResourceLogicId": 122202, "conditions": [ { "apiParameterId": 1636906, "value": "cors/form-login" } ], "link": "/api-definitions/v2/endpoints/503130/versions/4/resources/3143802/operations/123a567b-fe5c-4d52-9cc9-a9cd870f0829", "metadata": { "isActive": true }, "method": "POST", "operationId": "123a567b-fe5c-4d52-9cc9-a9cd870f0829", "operationName": "Form Data", "operationPurpose": "ACCOUNT_VERIFICATION" }, { "apiEndPointId": 493213, "apiResourceId": 3055228, "apiResourceLogicId": 118374, "link": "/api-definitions/v2/endpoints/493213/versions/1/resources/3055228/operations/123a567b-5f82-44e8-95cd-cdcff189a1f2", "metadata": { "isActive": true }, "method": "GET", "operationId": "123a567b-5f82-44e8-95cd-cdcff189a1f2", "operationName": "ProtectedPurpose2", "operationPurpose": "LOYALTY_POINTS" }, { "apiEndPointId": 464125, "apiResourceId": 3545852, "apiResourceLogicId": 106953, "link": "/api-definitions/v2/endpoints/464125/versions/2/resources/3545852/operations/ea603927-99a6-4c25-bd18-b51db7bbff25", "metadata": { "isActive": true }, "method": "GET", "operationId": "ea603927-99a6-4c25-bd18-b51db7bbff25", "operationName": "Purpose1", "operationPurpose": "ACCOUNT_VERIFICATION" }, { "apiEndPointId": 291184, "apiResourceId": 1234567, "apiResourceLogicId": 11737, "conditions": [ { "apiParameterId": 1014208 } ], "link": "/api-definitions/v2/endpoints/291184/versions/2/resources/1234567/operations/c00009d1-64bb-49e5-a492-a81e9aeed1b7", "metadata": { "isActive": true }, "method": "POST", "operationId": "c00009d1-64bb-49e5-a492-a81e9aeed1b7", "operationName": "login", "operationParameter": { "username": { "parameterId": 1014209, "usedForLogin": null } }, "operationPurpose": "LOGIN" } ], "resources": [ { "apiEndPointId": 503130, "apiResourceId": 3143802, "apiResourceLogicId": 122202, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 778229, "apiParameterId": 1636906, "apiParameterLocation": "query", "apiParameterName": "route", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 572570, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 365993, "apiResourceMethodLogicId": 170106, "methodRestrictions": null } ], "apiResourceName": "Login Form Data", "createDate": "2019-10-02T15:39:03+0000", "createdBy": "jsmith", "link": "/api-definitions/v2/endpoints/503130/versions/4/resources/3143802", "lockVersion": 0, "metadata": { "methodsEnabled": 1, "methodsWithOperations": 1, "operationCount": 3 }, "resourcePath": "/index.php", "updateDate": "2019-10-02T15:39:03+0000", "updatedBy": "jsmith" }, { "apiEndPointId": 463140, "apiResourceId": 3545900, "apiResourceLogicId": 106954, "apiResourceMethods": [ { "apiParameters": [], "apiResourceMethod": "POST", "apiResourceMethodId": 474030, "apiResourceMethodLogicId": 147694, "methodRestrictions": null }, { "apiParameters": [], "apiResourceMethod": "GET", "apiResourceMethodId": 474029, "apiResourceMethodLogicId": 147693, "methodRestrictions": null } ], "apiResourceName": "Resource1", "createDate": "2020-03-04T15:24:36+0000", "createdBy": "mrossi", "link": "/api-definitions/v2/endpoints/463140/versions/4/resources/3545900", "lockVersion": 0, "metadata": { "methodsEnabled": 2, "methodsWithOperations": 1, "operationCount": 1 }, "resourcePath": "/index.php", "updateDate": "2020-03-04T15:24:36+0000", "updatedBy": "afero" }, { "apiEndPointId": 464125, "apiResourceId": 3545852, "apiResourceLogicId": 106953, "apiResourceMethods": [ { "apiParameters": [], "apiResourceMethod": "GET", "apiResourceMethodId": 474019, "apiResourceMethodLogicId": 147691, "methodRestrictions": null }, { "apiParameters": [], "apiResourceMethod": "POST", "apiResourceMethodId": 474020, "apiResourceMethodLogicId": 147692, "methodRestrictions": null } ], "apiResourceName": "Resource1", "createDate": "2020-03-04T15:23:59+0000", "createdBy": "jdupont", "link": "/api-definitions/v2/endpoints/464125/versions/2/resources/3545852", "lockVersion": 0, "metadata": { "methodsEnabled": 2, "methodsWithOperations": 1, "operationCount": 1 }, "resourcePath": "/index.php", "updateDate": "2020-03-04T15:23:59+0000", "updatedBy": "szhang" }, { "apiEndPointId": 291184, "apiResourceId": 1234567, "apiResourceLogicId": 11737, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [ { "apiChildParameters": [], "apiParamLogicId": 56167, "apiParameterId": 1014208, "apiParameterLocation": "body", "apiParameterName": "j_password", "apiParameterNotes": null, "apiParameterRequired": false, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": null, "array": false, "pathParamLocationId": null, "response": false }, { "apiChildParameters": [], "apiParamLogicId": 56168, "apiParameterId": 1014209, "apiParameterLocation": "body", "apiParameterName": "j_username", "apiParameterNotes": null, "apiParameterRequired": false, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": null, "array": false, "pathParamLocationId": null, "response": false } ], "apiParamLogicId": 56166, "apiParameterId": 1014207, "apiParameterLocation": "body", "apiParameterName": "root", "apiParameterNotes": null, "apiParameterRequired": false, "apiParameterRestriction": null, "apiParameterType": "json/xml", "apiResourceMethParamId": 412851, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 268261, "apiResourceMethodLogicId": 15869, "methodRestrictions": null } ], "apiResourceName": "test", "createDate": "2019-04-09T03:01:10+0000", "createdBy": "mrossi", "link": "/api-definitions/v2/endpoints/291184/versions/2/resources/1234567", "lockVersion": 0, "metadata": { "methodsEnabled": 1, "methodsWithOperations": 1, "operationCount": 1 }, "resourcePath": "/base", "updateDate": "2019-04-09T03:01:10+0000", "updatedBy": "jdupont" } ] }, "schema": { "additionalProperties": false, "description": "Collects data for the operation report.", "properties": { "apiEndPoints": { "description": "API endpoints and their data.", "items": { "additionalProperties": false, "description": "Collects data about an API endpoint.", "properties": { "apiEndPointHosts": { "description": "API endpoint hostnames.", "items": { "description": "A hostname used to publish the API through Akamai.", "minLength": 1, "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "Identifies the API endpoint.", "type": "integer" }, "apiEndPointName": { "description": "The name of the API endpoint.", "minLength": 1, "type": "string" }, "basePath": { "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` field in the corresponding parameter definition matches the name that you specified in the resource path.", "minLength": 1, "type": "string" }, "caseSensitive": { "description": "Whether to match on case sensitivity.", "type": "boolean" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "minLength": 1, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "Collects data about the API endpoint's activation status.", "properties": { "status": { "description": "The activation status, either `PENDING` if the version contains changes that are being propagated, `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.", "minLength": 1, "nullable": true, "type": "string" }, "timestamp": { "description": "The ISO 8601 timestamp indicating when the activation status was last updated.", "minLength": 1, "nullable": true, "type": "string" }, "versionNumber": { "description": "The endpoint's version.", "nullable": true, "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/activation-status.yaml" } }, "stagingVersion": { "additionalProperties": false, "description": "Collects data about the API endpoint's activation status.", "properties": { "status": { "description": "The activation status, either `PENDING` if the version contains changes that are being propagated, `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.", "minLength": 1, "nullable": true, "type": "string" }, "timestamp": { "description": "The ISO 8601 timestamp indicating when the activation status was last updated.", "minLength": 1, "nullable": true, "type": "string" }, "versionNumber": { "description": "The endpoint's version.", "nullable": true, "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/activation-status.yaml" } } }, "required": [ "apiEndPointId", "apiEndPointHosts", "apiEndPointName", "basePath", "caseSensitive", "link" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-summary.yaml" } }, "type": "array" }, "operations": { "description": "Operations and their data.", "items": { "additionalProperties": false, "description": "Collects data for an operation.", "properties": { "apiEndPointId": { "description": "Identifies the API endpoint.", "type": "integer" }, "apiResourceId": { "description": "Identifies the API resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "conditions": { "description": "Specify the parameter values to match with.", "items": { "additionalProperties": false, "properties": { "apiParameterId": { "description": "Identifies the API parameter.", "type": "integer" }, "value": { "description": "The parameter value to match with.", "nullable": true, "type": "string" } }, "required": [ "apiParameterId" ], "type": "object" }, "nullable": true, "type": "array" }, "failureConditions": { "description": "Specify conditions to capture data on unsuccessful attempts to use the resource. You can set up failure reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "minLength": 1, "type": "string" }, "metadata": { "additionalProperties": false, "description": "Additional information about the operation.", "nullable": true, "properties": { "isActive": { "description": "Informs you if the operation is currently active in production or staging.", "type": "boolean" } }, "type": "object" }, "method": { "description": "The HTTP method used in combination with the resource. Choose between `HEAD`, `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, or `OPTIONS`.", "enum": [ "HEAD", "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS" ], "type": "string" }, "multistepGroupId": { "description": "__Read-only__ Identifies the multistep group for the operation.", "readOnly": true, "type": "string" }, "multistepGroupName": { "description": "__Read-only__ Identifies the multistep group name.", "readOnly": true, "type": "string" }, "operationId": { "description": "__Read-only__ Identifies the operation.", "readOnly": true, "type": "string" }, "operationName": { "description": "The name of the operation. Use the same name you gave to the resource if you only specify one operation.", "minLength": 1, "type": "string" }, "operationParameter": { "additionalProperties": { "additionalProperties": false, "description": "Additional properties describing the parameter.", "properties": { "arrayIndexes": { "description": "Corresponding array parameters used to find data.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "parameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "referenceOperationId": { "description": "Identifies the referred operation.", "nullable": true, "type": "string" }, "referenceOperationLocation": { "description": "Identifies the operation parameter location of the referred operation, either `USERNAME`, `USER_EMAIL`, `USER_PHONE_NUMBER`, `USER_FIRST_NAME`, `USER_LAST_NAME`, or `USER_OTHER_ID`.", "enum": [ "USERNAME", "USER_EMAIL", "USER_PHONE_NUMBER", "USER_OTHER_ID", "USER_FIRST_NAME", "USER_LAST_NAME" ], "nullable": true, "type": "string" }, "usedForLogin": { "description": "Indicates if the parameter is used for login.", "nullable": true, "type": "boolean" } }, "type": "object" }, "description": "Collects data for operation parameters defined when the resource was created.", "nullable": true, "properties": { "userEmail": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userFirstName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userLastName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userOtherId": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userPhoneNumber": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "username": { "description": "If the `operationPurpose` supports a username, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource). Required for `LOGIN`, `ACCOUNT_VERIFICATION`, and `PASSWORD RESET`.", "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/operation-parameter.yaml" } }, "operationPurpose": { "description": "The task this operation serves. Choose between `LOGIN`, `ACCOUNT_VERIFICATION`, `ACCOUNT_CREATION`, `ACCOUNT_UPDATE`, `PASSWORD_RESET`, `PASSWORD_CHANGE`, `PAYMENT`, `GIFTCARD_BALANCE_CHECK`, `LOYALTY_POINTS`, `SEARCH`, `ADD_TO_CART`, or `OTHER`.", "enum": [ "LOGIN", "ACCOUNT_VERIFICATION", "ACCOUNT_CREATION", "ACCOUNT_UPDATE", "PASSWORD_RESET", "PASSWORD_CHANGE", "PAYMENT", "GIFTCARD_BALANCE_CHECK", "LOYALTY_POINTS", "SEARCH", "ADD_TO_CART", "OTHER" ], "type": "string" }, "originUserIdCondition": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "successConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" } }, "required": [ "apiEndPointId", "apiResourceId", "apiResourceLogicId", "link", "operationId", "operationName", "operationPurpose", "method" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-summary.yaml" } }, "type": "array" }, "resources": { "description": "Resources and their data.", "items": { "additionalProperties": false, "description": "Collects data about a resource.", "properties": { "apiEndPointId": { "description": "Identifies the API endpoint.", "type": "integer" }, "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "Identifies the API resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethods": { "description": "Method objects that represent HTTP methods the resource may respond to.", "items": { "additionalProperties": false, "description": "An HTTP method to which a resource may respond.", "properties": { "apiParameters": { "description": "Parameter objects associated with the method.", "items": { "additionalProperties": false, "description": "An HTTP method to which a resource may respond.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A nested API parameter object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameters-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "The unique identifier for the parameter.", "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "body", "header", "path", "cookie" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "Optional notes describing the parameter's function. If you specify an empty string in the request or omit this field from the object, the JSON response reflects it as `null`.", "nullable": true, "type": "string" }, "apiParameterRequired": { "description": "Whether the parameter is needed. If the corresponding `apiParameterLocation` is `path`, set this field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Specify restrictions and XML representation rules for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "If you enabled an `array` field, specify restrictions on array parameters.", "nullable": true, "properties": { "collectionFormat": { "description": "The format of the array that specifies how you separated array values. Choose 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 multiple parameter instances.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "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 unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Specify length restrictions for string parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Specify range restrictions on number parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "type": "integer" }, "numberRangeMin": { "description": "The minimum range restriction.", "type": "integer" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Specify range restrictions for integer parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "The maximum allowed size of the response body.", "nullable": true, "properties": { "maxBodySize": { "description": "Specify the size limit of the response body. Choose `SIZE_6K` for 6KB, `SIZE_8K` for 8KB, `SIZE_12K` for 12KB, or `NO_LIMIT` to allow any response size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "Response status codes to be matched to the response. Specify `null` or leave empty to apply the definition to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "XML settings for the parameter.", "nullable": true, "properties": { "attribute": { "description": "Whether the parameter should be represented as an attribute.", "nullable": true, "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified when you created the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "nullable": true, "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "nullable": true, "type": "string" }, "wrapped": { "description": "Whether the parameter should be wrapped in a parent XML element.", "nullable": true, "type": "boolean" } }, "type": "object" } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean` for cookies, headers, query string, and path parameters. For request body following types are supported: `json`, `xml`, or `json/xml` for either JSON or XML objects, or `urlencoded`.", "enum": [ "string", "integer", "number", "boolean", "json/xml", "json", "xml", "urlencoded" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter belongs to the response.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameters.yaml" } }, "type": "array" }, "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "DELETE", "GET", "PATCH", "PUT", "POST", "OPTIONS", "HEAD" ], "type": "string" }, "apiResourceMethodId": { "description": "The unique identifier for the resource's allowed method.", "type": "integer" }, "apiResourceMethodLogicId": { "description": "The unique identifier for the resource's method across all endpoint versions.", "type": "integer" }, "methodRestrictions": { "additionalProperties": false, "description": "Collects data for restrictions on the method level.", "nullable": true, "properties": { "allowMethodUndefinedParameters": { "additionalProperties": false, "description": "Specify whether undefined parameters are allowed, overriding the top-level setting for undefined parameters.", "properties": { "body": { "description": "Whether undefined parameters are allowed in request body.", "type": "boolean" }, "cookie": { "description": "Whether undefined parameters are allowed in request cookies.", "type": "boolean" }, "header": { "description": "Whether undefined parameters are allowed in request headers.", "type": "boolean" }, "query": { "description": "Whether undefined parameters are allowed in request query string.", "type": "boolean" } }, "required": [ "header", "cookie", "query", "body" ], "type": "object" }, "jsonRequestRejectDuplicates": { "description": "Whether to reject duplicate JSON requests.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/method-restrictions.yaml" } } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-methods.yaml" } }, "nullable": true, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "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 field from the object, the JSON response reflects it as an empty string.", "minLength": 1, "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients. Don't include hostnames.", "minLength": 1, "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](#concurrencycontrol) for details.", "type": "integer" }, "metadata": { "additionalProperties": false, "description": "Information about the number of methods enabled, methods with assigned operations, and operations.", "nullable": true, "properties": { "methodsEnabled": { "description": "The number of methods enabled for the resource.", "type": "integer" }, "methodsWithOperations": { "description": "The number of methods that have assigned operations.", "type": "integer" }, "operationCount": { "description": "The total number of operations assigned to the resource.", "type": "integer" } }, "required": [ "methodsEnabled", "methodsWithOperations", "operationCount" ], "type": "object" }, "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 resource's path, with the API base path omitted. For example, `/login`.", "minLength": 1, "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiEndPointId", "apiResourceId", "apiResourceLogicId", "apiResourceName", "link", "metadata", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-summary.yaml" } }, "type": "array" }, "validation": { "additionalProperties": false, "description": "Contains warnings, errors, or notices determined by validating the match target.", "properties": { "errors": { "description": "__Read-only__ Errors.", "items": { "additionalProperties": false, "description": "Contains feedback on validation.", "properties": { "detail": { "description": "The explanation of the error message.", "type": "string" }, "fieldName": { "description": "The name of the field causing the validation problem.", "type": "string" }, "jsonReference": { "description": "The JSON reference to the field in the resource.", "type": "string" }, "operationId": { "description": "Identifies the operation.", "nullable": true, "type": "string" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "title", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/validation-dto.yaml" } }, "readOnly": true, "type": "array" }, "notices": { "description": "__Read-only__ Notices.", "items": { "additionalProperties": false, "description": "Contains feedback on validation.", "properties": { "detail": { "description": "The explanation of the error message.", "type": "string" }, "fieldName": { "description": "The name of the field causing the validation problem.", "type": "string" }, "jsonReference": { "description": "The JSON reference to the field in the resource.", "type": "string" }, "operationId": { "description": "Identifies the operation.", "nullable": true, "type": "string" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "title", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/validation-dto.yaml" } }, "readOnly": true, "type": "array" }, "warnings": { "description": "__Read-only__ Warnings.", "items": { "additionalProperties": false, "description": "Contains feedback on validation.", "properties": { "detail": { "description": "The explanation of the error message.", "type": "string" }, "fieldName": { "description": "The name of the field causing the validation problem.", "type": "string" }, "jsonReference": { "description": "The JSON reference to the field in the resource.", "type": "string" }, "operationId": { "description": "Identifies the operation.", "nullable": true, "type": "string" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "title", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/validation-dto.yaml" } }, "readOnly": true, "type": "array" } }, "required": [ "notices", "errors", "warnings" ], "type": "object", "x-akamai": { "file-path": "schemas/validation.yaml" } } }, "required": [ "apiEndPoints", "operations", "resources" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-report.yaml" } } } }, "description": "Successful response." } }, "summary": "Search operations", "tags": [ "Filter operations" ] }, "x-akamai": { "file-path": "paths/search-operations.yaml", "path-info": "/search-operations" } }, "/verify-operations": { "post": { "description": "Verify that operations exist. Specify a list of operation summaries and receive a list of matching operations and their details, along with any submission errors.", "externalDocs": { "description": "See documentation for this operation in Akamai's API Endpoint Definition API", "url": "https://techdocs.akamai.com/api-definitions/reference/post-operation" }, "operationId": "post-operation", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "operations": [ { "apiEndPointId": 12, "apiResourceLogicId": 234, "operationId": "123e4567-e89b-12d3-a456-426614174000" }, { "apiEndPointId": 12, "apiResourceLogicId": 235, "operationId": "123e4567-e89b-12d3-a456-426614174001" }, { "apiEndPointId": 12, "apiResourceLogicId": 235, "operationId": "123e4567-e89b-12d3-a456-426614174002" } ] }, "schema": { "additionalProperties": false, "description": "Collects data for operation verification.", "properties": { "operations": { "description": "Operations to verify.", "items": { "additionalProperties": false, "description": "Collects data about operations, used in operation verification.", "properties": { "apiEndPointId": { "description": "Identifies the API endpoint.", "type": "integer" }, "apiResourceLogicId": { "description": "Identifies the API resource.", "type": "integer" }, "operationId": { "description": "Identifies the resource operation.", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "type": "string" } }, "required": [ "apiEndPointId", "apiResourceLogicId", "operationId" ], "type": "object", "x-akamai": { "file-path": "schemas/verify-operation.yaml" } }, "minItems": 1, "type": "array" } }, "required": [ "operations" ], "type": "object", "x-akamai": { "file-path": "schemas/verify-operation-list.yaml" } } } } }, "responses": { "200": { "content": { "application/json": { "example": { "apiEndPoints": [ { "apiEndPointHosts": [ "www.bot-staging.net", "www.botman-test1.com", "www.botman-test.com", "www.test-login.com" ], "apiEndPointId": 503130, "apiEndPointName": "E2ETest", "basePath": "/login", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/503130/versions/4", "productionVersion": { "status": "ACTIVE", "timestamp": "2019-10-02T16:04:14+0000", "versionNumber": 4 }, "stagingVersion": { "status": "ACTIVE", "timestamp": "2019-10-02T15:59:07+0000", "versionNumber": 4 } }, { "apiEndPointHosts": [ "www.staging-activated.com" ], "apiEndPointId": 464125, "apiEndPointName": "Activated", "basePath": "/staging", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/464125/versions/2", "productionVersion": {}, "stagingVersion": { "status": "ACTIVE", "timestamp": "2020-03-04T15:28:25+0000", "versionNumber": 2 } }, { "apiEndPointHosts": [ "*.vtest.com", "www.test.com" ], "apiEndPointId": 502216, "apiEndPointName": "Account protections", "basePath": "/webinline", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/502216/versions/2", "productionVersion": {}, "stagingVersion": { "status": "ACTIVE", "timestamp": "2019-09-24T03:03:05+0000", "versionNumber": 2 } }, { "apiEndPointHosts": [ "test.tony.com" ], "apiEndPointId": 291184, "apiEndPointName": "test", "basePath": "/", "caseSensitive": true, "link": "/api-definitions/v2/endpoints/291184/versions/2", "productionVersion": { "status": "ACTIVE", "timestamp": "2018-07-06T16:06:19+0000", "versionNumber": 1 }, "stagingVersion": { "status": "ACTIVE", "timestamp": "2019-04-09T03:39:18+0000", "versionNumber": 2 } } ], "operations": [ { "apiEndPointId": 503130, "apiResourceId": 3143802, "apiResourceLogicId": 122202, "conditions": [ { "apiParameterId": 1636906, "value": "cors/form-login" } ], "link": "/api-definitions/v2/endpoints/503130/versions/4/resources/3143802/operations/123a567b-fe5c-4d52-9cc9-a9cd870f0829", "metadata": { "isActive": true }, "method": "POST", "operationId": "123a567b-fe5c-4d52-9cc9-a9cd870f0829", "operationName": "Form Data", "operationPurpose": "ACCOUNT_VERIFICATION" }, { "apiEndPointId": 493213, "apiResourceId": 3055228, "apiResourceLogicId": 118374, "link": "/api-definitions/v2/endpoints/493213/versions/1/resources/3055228/operations/123a567b-5f82-44e8-95cd-cdcff189a1f2", "metadata": { "isActive": true }, "method": "GET", "operationId": "123a567b-5f82-44e8-95cd-cdcff189a1f2", "operationName": "ProtectedPurpose2", "operationPurpose": "LOYALTY_POINTS" }, { "apiEndPointId": 464125, "apiResourceId": 3545852, "apiResourceLogicId": 106953, "link": "/api-definitions/v2/endpoints/464125/versions/2/resources/3545852/operations/ea603927-99a6-4c25-bd18-b51db7bbff25", "metadata": { "isActive": true }, "method": "GET", "operationId": "ea603927-99a6-4c25-bd18-b51db7bbff25", "operationName": "Purpose1", "operationPurpose": "ACCOUNT_VERIFICATION" }, { "apiEndPointId": 291184, "apiResourceId": 1234567, "apiResourceLogicId": 11737, "conditions": [ { "apiParameterId": 1014208 } ], "link": "/api-definitions/v2/endpoints/291184/versions/2/resources/1234567/operations/c00009d1-64bb-49e5-a492-a81e9aeed1b7", "metadata": { "isActive": true }, "method": "POST", "operationId": "c00009d1-64bb-49e5-a492-a81e9aeed1b7", "operationName": "login", "operationParameter": { "username": { "parameterId": 1014209, "usedForLogin": null } }, "operationPurpose": "LOGIN" } ], "resources": [ { "apiEndPointId": 503130, "apiResourceId": 3143802, "apiResourceLogicId": 122202, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [], "apiParamLogicId": 778229, "apiParameterId": 1636906, "apiParameterLocation": "query", "apiParameterName": "route", "apiParameterNotes": null, "apiParameterRequired": true, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": 572570, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 365993, "apiResourceMethodLogicId": 170106, "methodRestrictions": null } ], "apiResourceName": "Login Form Data", "createDate": "2019-10-02T15:39:03+0000", "createdBy": "jsmith", "link": "/api-definitions/v2/endpoints/503130/versions/4/resources/3143802", "lockVersion": 0, "metadata": { "methodsEnabled": 1, "methodsWithOperations": 1, "operationCount": 3 }, "resourcePath": "/index.php", "updateDate": "2019-10-02T15:39:03+0000", "updatedBy": "jsmith" }, { "apiEndPointId": 463140, "apiResourceId": 3545900, "apiResourceLogicId": 106954, "apiResourceMethods": [ { "apiParameters": [], "apiResourceMethod": "POST", "apiResourceMethodId": 474030, "apiResourceMethodLogicId": 147694, "methodRestrictions": null }, { "apiParameters": [], "apiResourceMethod": "GET", "apiResourceMethodId": 474029, "apiResourceMethodLogicId": 147693, "methodRestrictions": null } ], "apiResourceName": "Resource1", "createDate": "2020-03-04T15:24:36+0000", "createdBy": "mrossi", "link": "/api-definitions/v2/endpoints/463140/versions/4/resources/3545900", "lockVersion": 0, "metadata": { "methodsEnabled": 2, "methodsWithOperations": 1, "operationCount": 1 }, "resourcePath": "/index.php", "updateDate": "2020-03-04T15:24:36+0000", "updatedBy": "afero" }, { "apiEndPointId": 464125, "apiResourceId": 3545852, "apiResourceLogicId": 106953, "apiResourceMethods": [ { "apiParameters": [], "apiResourceMethod": "GET", "apiResourceMethodId": 474019, "apiResourceMethodLogicId": 147691, "methodRestrictions": null }, { "apiParameters": [], "apiResourceMethod": "POST", "apiResourceMethodId": 474020, "apiResourceMethodLogicId": 147692, "methodRestrictions": null } ], "apiResourceName": "Resource1", "createDate": "2020-03-04T15:23:59+0000", "createdBy": "jdupont", "link": "/api-definitions/v2/endpoints/464125/versions/2/resources/3545852", "lockVersion": 0, "metadata": { "methodsEnabled": 2, "methodsWithOperations": 1, "operationCount": 1 }, "resourcePath": "/index.php", "updateDate": "2020-03-04T15:23:59+0000", "updatedBy": "szhang" }, { "apiEndPointId": 291184, "apiResourceId": 1234567, "apiResourceLogicId": 11737, "apiResourceMethods": [ { "apiParameters": [ { "apiChildParameters": [ { "apiChildParameters": [], "apiParamLogicId": 56167, "apiParameterId": 1014208, "apiParameterLocation": "body", "apiParameterName": "j_password", "apiParameterNotes": null, "apiParameterRequired": false, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": null, "array": false, "pathParamLocationId": null, "response": false }, { "apiChildParameters": [], "apiParamLogicId": 56168, "apiParameterId": 1014209, "apiParameterLocation": "body", "apiParameterName": "j_username", "apiParameterNotes": null, "apiParameterRequired": false, "apiParameterRestriction": null, "apiParameterType": "string", "apiResourceMethParamId": null, "array": false, "pathParamLocationId": null, "response": false } ], "apiParamLogicId": 56166, "apiParameterId": 1014207, "apiParameterLocation": "body", "apiParameterName": "root", "apiParameterNotes": null, "apiParameterRequired": false, "apiParameterRestriction": null, "apiParameterType": "json/xml", "apiResourceMethParamId": 412851, "array": false, "pathParamLocationId": null, "response": false } ], "apiResourceMethod": "POST", "apiResourceMethodId": 268261, "apiResourceMethodLogicId": 15869, "methodRestrictions": null } ], "apiResourceName": "test", "createDate": "2019-04-09T03:01:10+0000", "createdBy": "mrossi", "link": "/api-definitions/v2/endpoints/291184/versions/2/resources/1234567", "lockVersion": 0, "metadata": { "methodsEnabled": 1, "methodsWithOperations": 1, "operationCount": 1 }, "resourcePath": "/base", "updateDate": "2019-04-09T03:01:10+0000", "updatedBy": "jdupont" } ] }, "schema": { "additionalProperties": false, "description": "Collects data for the operation report.", "properties": { "apiEndPoints": { "description": "API endpoints and their data.", "items": { "additionalProperties": false, "description": "Collects data about an API endpoint.", "properties": { "apiEndPointHosts": { "description": "API endpoint hostnames.", "items": { "description": "A hostname used to publish the API through Akamai.", "minLength": 1, "type": "string" }, "minItems": 1, "type": "array" }, "apiEndPointId": { "description": "Identifies the API endpoint.", "type": "integer" }, "apiEndPointName": { "description": "The name of the API endpoint.", "minLength": 1, "type": "string" }, "basePath": { "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` field in the corresponding parameter definition matches the name that you specified in the resource path.", "minLength": 1, "type": "string" }, "caseSensitive": { "description": "Whether to match on case sensitivity.", "type": "boolean" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "minLength": 1, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "Collects data about the API endpoint's activation status.", "properties": { "status": { "description": "The activation status, either `PENDING` if the version contains changes that are being propagated, `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.", "minLength": 1, "nullable": true, "type": "string" }, "timestamp": { "description": "The ISO 8601 timestamp indicating when the activation status was last updated.", "minLength": 1, "nullable": true, "type": "string" }, "versionNumber": { "description": "The endpoint's version.", "nullable": true, "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/activation-status.yaml" } }, "stagingVersion": { "additionalProperties": false, "description": "Collects data about the API endpoint's activation status.", "properties": { "status": { "description": "The activation status, either `PENDING` if the version contains changes that are being propagated, `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.", "minLength": 1, "nullable": true, "type": "string" }, "timestamp": { "description": "The ISO 8601 timestamp indicating when the activation status was last updated.", "minLength": 1, "nullable": true, "type": "string" }, "versionNumber": { "description": "The endpoint's version.", "nullable": true, "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/activation-status.yaml" } } }, "required": [ "apiEndPointId", "apiEndPointHosts", "apiEndPointName", "basePath", "caseSensitive", "link" ], "type": "object", "x-akamai": { "file-path": "schemas/api-endpoint-summary.yaml" } }, "type": "array" }, "operations": { "description": "Operations and their data.", "items": { "additionalProperties": false, "description": "Collects data for an operation.", "properties": { "apiEndPointId": { "description": "Identifies the API endpoint.", "type": "integer" }, "apiResourceId": { "description": "Identifies the API resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "conditions": { "description": "Specify the parameter values to match with.", "items": { "additionalProperties": false, "properties": { "apiParameterId": { "description": "Identifies the API parameter.", "type": "integer" }, "value": { "description": "The parameter value to match with.", "nullable": true, "type": "string" } }, "required": [ "apiParameterId" ], "type": "object" }, "nullable": true, "type": "array" }, "failureConditions": { "description": "Specify conditions to capture data on unsuccessful attempts to use the resource. You can set up failure reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients.", "minLength": 1, "type": "string" }, "metadata": { "additionalProperties": false, "description": "Additional information about the operation.", "nullable": true, "properties": { "isActive": { "description": "Informs you if the operation is currently active in production or staging.", "type": "boolean" } }, "type": "object" }, "method": { "description": "The HTTP method used in combination with the resource. Choose between `HEAD`, `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, or `OPTIONS`.", "enum": [ "HEAD", "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS" ], "type": "string" }, "multistepGroupId": { "description": "__Read-only__ Identifies the multistep group for the operation.", "readOnly": true, "type": "string" }, "multistepGroupName": { "description": "__Read-only__ Identifies the multistep group name.", "readOnly": true, "type": "string" }, "operationId": { "description": "__Read-only__ Identifies the operation.", "readOnly": true, "type": "string" }, "operationName": { "description": "The name of the operation. Use the same name you gave to the resource if you only specify one operation.", "minLength": 1, "type": "string" }, "operationParameter": { "additionalProperties": { "additionalProperties": false, "description": "Additional properties describing the parameter.", "properties": { "arrayIndexes": { "description": "Corresponding array parameters used to find data.", "items": { "additionalProperties": false, "description": "The parameter and its index within the array.", "properties": { "apiParameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "index": { "description": "The location of the parameter's data within the array.", "type": "integer" } }, "required": [ "apiParameterId", "index" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-atomic-condition-array-index.yaml" } }, "type": "array" }, "parameterId": { "description": "Identifies the parameter.", "format": "int64", "type": "integer" }, "referenceOperationId": { "description": "Identifies the referred operation.", "nullable": true, "type": "string" }, "referenceOperationLocation": { "description": "Identifies the operation parameter location of the referred operation, either `USERNAME`, `USER_EMAIL`, `USER_PHONE_NUMBER`, `USER_FIRST_NAME`, `USER_LAST_NAME`, or `USER_OTHER_ID`.", "enum": [ "USERNAME", "USER_EMAIL", "USER_PHONE_NUMBER", "USER_OTHER_ID", "USER_FIRST_NAME", "USER_LAST_NAME" ], "nullable": true, "type": "string" }, "usedForLogin": { "description": "Indicates if the parameter is used for login.", "nullable": true, "type": "boolean" } }, "type": "object" }, "description": "Collects data for operation parameters defined when the resource was created.", "nullable": true, "properties": { "userEmail": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userFirstName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userLastName": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userOtherId": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "userPhoneNumber": { "description": "If the `operationPurpose` is `ACCOUNT_CREATION` or `PAYMENT`, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource).", "type": "object" }, "username": { "description": "If the `operationPurpose` supports a username, specify the `apiParameterId` you defined when you [created the resource](https://techdocs.akamai.com/api-definitions/reference/post-resource). Required for `LOGIN`, `ACCOUNT_VERIFICATION`, and `PASSWORD RESET`.", "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/operation-parameter.yaml" } }, "operationPurpose": { "description": "The task this operation serves. Choose between `LOGIN`, `ACCOUNT_VERIFICATION`, `ACCOUNT_CREATION`, `ACCOUNT_UPDATE`, `PASSWORD_RESET`, `PASSWORD_CHANGE`, `PAYMENT`, `GIFTCARD_BALANCE_CHECK`, `LOYALTY_POINTS`, `SEARCH`, `ADD_TO_CART`, or `OTHER`.", "enum": [ "LOGIN", "ACCOUNT_VERIFICATION", "ACCOUNT_CREATION", "ACCOUNT_UPDATE", "PASSWORD_RESET", "PASSWORD_CHANGE", "PAYMENT", "GIFTCARD_BALANCE_CHECK", "LOYALTY_POINTS", "SEARCH", "ADD_TO_CART", "OTHER" ], "type": "string" }, "originUserIdCondition": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "successConditions": { "description": "Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation `type` except `SEARCH` and `ADD_TO_CART`.", "items": { "additionalProperties": false, "description": "Collects data for response conditions.", "nullable": true, "properties": { "headerName": { "description": "Specify the header's name. Only applicable for `HEADER_*` types.", "type": "string" }, "positiveMatch": { "description": "Enable to match on the condition.", "nullable": true, "type": "boolean" }, "suppressFromClientResponse": { "description": "Enable to not send the response header to the requesting client. Only applicable for `HEADER_*` and `COOKIE_NAME` types.", "type": "boolean" }, "type": { "description": "Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_GREATER_THAN`, `HEADER_VALUE_LESS_THAN`, `HEADER_VALUE_BETWEEN`, `HTTP_STATUS`, `HEADER_NAME`, `BODY_XPATH`, or `BODY_XPATH_JSON`.", "enum": [ "COOKIE_NAME", "HEADER_VALUE", "HEADER_VALUE_GREATER_THAN", "HEADER_VALUE_LESS_THAN", "HEADER_VALUE_BETWEEN", "HTTP_STATUS", "HEADER_NAME", "BODY_XPATH", "BODY_XPATH_JSON" ], "type": "string" }, "valueCase": { "description": "Whether to consider the case sensitivity of the provided values. Only applicable for `HEADER_VALUE`, `COOKIE_NAME`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "valueWildcard": { "description": "Whether to interpret `*` and `?` as wildcards. Only applicable for `HEADER_VALUE`, `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "boolean" }, "values": { "description": "Values to match on. Specify one or more value if the `type` is `HTTP_STATUS`, `COOKIE_NAME`, `HEADER_VALUE`, `HEADER_VALUE_BETWEEN`, `BODY_XPATH`, or `BODY_XPATH_JSON`. Specify two values if the `type` is `HEADER_VALUE_BETWEEN`. Otherwise, specify only one value to match on.", "items": { "description": "A value to match on.", "maxLength": 255, "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "xPath": { "description": "A path in the response body to search at for a match. Only applicable for `BODY_XPATH` and `BODY_XPATH_JSON`.", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object", "x-akamai": { "file-path": "schemas/response-condition-dto.yaml" } }, "nullable": true, "type": "array" } }, "required": [ "apiEndPointId", "apiResourceId", "apiResourceLogicId", "link", "operationId", "operationName", "operationPurpose", "method" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-summary.yaml" } }, "type": "array" }, "resources": { "description": "Resources and their data.", "items": { "additionalProperties": false, "description": "Collects data about a resource.", "properties": { "apiEndPointId": { "description": "Identifies the API endpoint.", "type": "integer" }, "apiResourceClonedFromId": { "description": "For cloned resources, the unique identifier for the source resource.", "nullable": true, "type": "integer" }, "apiResourceId": { "description": "Identifies the API resource.", "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across all endpoint versions.", "type": "integer" }, "apiResourceMethods": { "description": "Method objects that represent HTTP methods the resource may respond to.", "items": { "additionalProperties": false, "description": "An HTTP method to which a resource may respond.", "properties": { "apiParameters": { "description": "Parameter objects associated with the method.", "items": { "additionalProperties": false, "description": "An HTTP method to which a resource may respond.", "properties": { "apiChildParameters": { "description": "Child JSON fields or XML elements for JSON or XML body type parameters.", "items": { "description": "A nested API parameter object.", "type": "object", "x-akamai": { "file-path": "schemas/api-parameters-nested.yaml" } }, "type": "array" }, "apiParamLogicId": { "description": "__Read-only__ The unique identifier for the parameter across all endpoint versions.", "readOnly": true, "type": "integer" }, "apiParameterId": { "description": "The unique identifier for the parameter.", "type": "integer" }, "apiParameterLocation": { "description": "The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter.", "enum": [ "query", "body", "header", "path", "cookie" ], "type": "string" }, "apiParameterName": { "description": "The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`.", "type": "string" }, "apiParameterNotes": { "description": "Optional notes describing the parameter's function. If you specify an empty string in the request or omit this field from the object, the JSON response reflects it as `null`.", "nullable": true, "type": "string" }, "apiParameterRequired": { "description": "Whether the parameter is needed. If the corresponding `apiParameterLocation` is `path`, set this field to `true`.", "type": "boolean" }, "apiParameterRestriction": { "additionalProperties": false, "description": "Specify restrictions and XML representation rules for the parameter.", "nullable": true, "properties": { "arrayRestriction": { "additionalProperties": false, "description": "If you enabled an `array` field, specify restrictions on array parameters.", "nullable": true, "properties": { "collectionFormat": { "description": "The format of the array that specifies how you separated array values. Choose 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 multiple parameter instances.", "enum": [ "csv", "ssv", "tsv", "pipes", "multi" ], "type": "string" }, "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 unique items.", "type": "boolean" } }, "type": "object" }, "lengthRestriction": { "additionalProperties": false, "description": "Specify length restrictions for string parameters.", "nullable": true, "properties": { "lengthMax": { "description": "The maximum allowed number of characters in the string.", "type": "integer" }, "lengthMin": { "description": "The minimum allowed number of characters in the string.", "type": "integer" } }, "type": "object" }, "numberRangeRestriction": { "additionalProperties": false, "description": "Specify range restrictions on number parameters.", "nullable": true, "properties": { "numberRangeMax": { "description": "The maximum range restriction.", "type": "integer" }, "numberRangeMin": { "description": "The minimum range restriction.", "type": "integer" } }, "type": "object" }, "rangeRestriction": { "additionalProperties": false, "description": "Specify range restrictions for integer parameters.", "nullable": true, "properties": { "rangeMax": { "description": "The maximum range restriction.", "type": "integer" }, "rangeMin": { "description": "The minimum range restriction.", "type": "integer" } }, "type": "object" }, "responseRestriction": { "additionalProperties": false, "description": "The maximum allowed size of the response body.", "nullable": true, "properties": { "maxBodySize": { "description": "Specify the size limit of the response body. Choose `SIZE_6K` for 6KB, `SIZE_8K` for 8KB, `SIZE_12K` for 12KB, or `NO_LIMIT` to allow any response size.", "enum": [ "SIZE_6K", "SIZE_8K", "SIZE_12K", "NO_LIMIT" ], "type": "string" }, "statusCodes": { "description": "Response status codes to be matched to the response. Specify `null` or leave empty to apply the definition to any response body.", "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "xmlConversionRule": { "additionalProperties": false, "description": "XML settings for the parameter.", "nullable": true, "properties": { "attribute": { "description": "Whether the parameter should be represented as an attribute.", "nullable": true, "type": "boolean" }, "name": { "description": "The name of the parameter in XML. By default, the XML name is the same as the parameter name specified when you created the API definition.", "type": "string" }, "namespace": { "description": "The XML namespace.", "nullable": true, "type": "string" }, "prefix": { "description": "The prefix for the XML namespace.", "nullable": true, "type": "string" }, "wrapped": { "description": "Whether the parameter should be wrapped in a parent XML element.", "nullable": true, "type": "boolean" } }, "type": "object" } }, "type": "object" }, "apiParameterType": { "description": "The data type of the parameter, either `string`, `integer`, `number`, `boolean` for cookies, headers, query string, and path parameters. For request body following types are supported: `json`, `xml`, or `json/xml` for either JSON or XML objects, or `urlencoded`.", "enum": [ "string", "integer", "number", "boolean", "json/xml", "json", "xml", "urlencoded" ], "type": "string" }, "apiResourceMethParamId": { "description": "__Read-only__ The unique identifier for the parameter's parent method.", "nullable": true, "readOnly": true, "type": "integer" }, "array": { "description": "Whether the parameter can express more than one value. This field 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` field.", "type": "boolean" }, "arrayItemNullable": { "description": "Indicates whether items in an array parameter can be `null`.", "nullable": true, "type": "boolean" }, "nullable": { "default": false, "description": "Indicates whether the parameter value can be `null`.", "nullable": true, "type": "boolean" }, "pathParamLocationId": { "description": "The index of a segment that includes a path parameter in a resource path. For example, given a path `\\books\\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`.", "nullable": true, "type": "integer" }, "response": { "description": "Whether the parameter belongs to the response.", "type": "boolean" } }, "required": [ "apiParameterName", "apiParameterType", "apiParameterRequired", "apiParameterLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/api-parameters.yaml" } }, "type": "array" }, "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "enum": [ "DELETE", "GET", "PATCH", "PUT", "POST", "OPTIONS", "HEAD" ], "type": "string" }, "apiResourceMethodId": { "description": "The unique identifier for the resource's allowed method.", "type": "integer" }, "apiResourceMethodLogicId": { "description": "The unique identifier for the resource's method across all endpoint versions.", "type": "integer" }, "methodRestrictions": { "additionalProperties": false, "description": "Collects data for restrictions on the method level.", "nullable": true, "properties": { "allowMethodUndefinedParameters": { "additionalProperties": false, "description": "Specify whether undefined parameters are allowed, overriding the top-level setting for undefined parameters.", "properties": { "body": { "description": "Whether undefined parameters are allowed in request body.", "type": "boolean" }, "cookie": { "description": "Whether undefined parameters are allowed in request cookies.", "type": "boolean" }, "header": { "description": "Whether undefined parameters are allowed in request headers.", "type": "boolean" }, "query": { "description": "Whether undefined parameters are allowed in request query string.", "type": "boolean" } }, "required": [ "header", "cookie", "query", "body" ], "type": "object" }, "jsonRequestRejectDuplicates": { "description": "Whether to reject duplicate JSON requests.", "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/method-restrictions.yaml" } } }, "required": [ "apiResourceMethod" ], "type": "object", "x-akamai": { "file-path": "schemas/api-resource-methods.yaml" } }, "nullable": true, "type": "array" }, "apiResourceName": { "description": "The name of the resource.", "type": "string" }, "createDate": { "description": "The ISO 8601 timestamp indicating when you created the resource.", "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 field from the object, the JSON response reflects it as an empty string.", "minLength": 1, "nullable": true, "type": "string" }, "link": { "description": "The location of the navigable resource within this API, for use by API clients. Don't include hostnames.", "minLength": 1, "nullable": true, "type": "string" }, "lockVersion": { "description": "The identifier used for optimistic locking. See [Concurrency control](#concurrencycontrol) for details.", "type": "integer" }, "metadata": { "additionalProperties": false, "description": "Information about the number of methods enabled, methods with assigned operations, and operations.", "nullable": true, "properties": { "methodsEnabled": { "description": "The number of methods enabled for the resource.", "type": "integer" }, "methodsWithOperations": { "description": "The number of methods that have assigned operations.", "type": "integer" }, "operationCount": { "description": "The total number of operations assigned to the resource.", "type": "integer" } }, "required": [ "methodsEnabled", "methodsWithOperations", "operationCount" ], "type": "object" }, "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 resource's path, with the API base path omitted. For example, `/login`.", "minLength": 1, "type": "string" }, "updateDate": { "description": "The ISO 8601 timestamp indicating when you last modified the resource.", "type": "string" }, "updatedBy": { "description": "The identifier for the user who last modified the resource.", "type": "string" } }, "required": [ "apiEndPointId", "apiResourceId", "apiResourceLogicId", "apiResourceName", "link", "metadata", "resourcePath" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-summary.yaml" } }, "type": "array" }, "validation": { "additionalProperties": false, "description": "Contains warnings, errors, or notices determined by validating the match target.", "properties": { "errors": { "description": "__Read-only__ Errors.", "items": { "additionalProperties": false, "description": "Contains feedback on validation.", "properties": { "detail": { "description": "The explanation of the error message.", "type": "string" }, "fieldName": { "description": "The name of the field causing the validation problem.", "type": "string" }, "jsonReference": { "description": "The JSON reference to the field in the resource.", "type": "string" }, "operationId": { "description": "Identifies the operation.", "nullable": true, "type": "string" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "title", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/validation-dto.yaml" } }, "readOnly": true, "type": "array" }, "notices": { "description": "__Read-only__ Notices.", "items": { "additionalProperties": false, "description": "Contains feedback on validation.", "properties": { "detail": { "description": "The explanation of the error message.", "type": "string" }, "fieldName": { "description": "The name of the field causing the validation problem.", "type": "string" }, "jsonReference": { "description": "The JSON reference to the field in the resource.", "type": "string" }, "operationId": { "description": "Identifies the operation.", "nullable": true, "type": "string" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "title", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/validation-dto.yaml" } }, "readOnly": true, "type": "array" }, "warnings": { "description": "__Read-only__ Warnings.", "items": { "additionalProperties": false, "description": "Contains feedback on validation.", "properties": { "detail": { "description": "The explanation of the error message.", "type": "string" }, "fieldName": { "description": "The name of the field causing the validation problem.", "type": "string" }, "jsonReference": { "description": "The JSON reference to the field in the resource.", "type": "string" }, "operationId": { "description": "Identifies the operation.", "nullable": true, "type": "string" }, "title": { "description": "The title of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "title", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/validation-dto.yaml" } }, "readOnly": true, "type": "array" } }, "required": [ "notices", "errors", "warnings" ], "type": "object", "x-akamai": { "file-path": "schemas/validation.yaml" } } }, "required": [ "apiEndPoints", "operations", "resources" ], "type": "object", "x-akamai": { "file-path": "schemas/operation-report.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "#/sensitivity: must have a minimum value of 1", "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d13f9326b05ca37d", "status": 400, "title": "Invalid Input Error", "type": "https://problems.luna.akamaiapis.net/appsec/error-types/INVALID-INPUT-ERROR" }, "schema": { "additionalProperties": true, "description": "Provides details on the data object that reflects the API\u2019s common response to error cases, and lists the API\u2019s range of response status codes for both error and success cases.", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "Detailed error messages provided by the server.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "type": "array" }, "fieldErrors": { "additionalProperties": { "description": "Additional error details.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "description": "Pointers to fields with invalid input. Values are messages that explain why the input is invalid.", "type": "object" }, "instance": { "description": "The URI that indicates the error instance.", "type": "string" }, "status": { "description": "The HTTP status code.", "type": "integer" }, "title": { "description": "The name of the error.", "type": "string" }, "type": { "description": "The URL for the error type.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/api-definitions/reference/400). The request body has invalid fields.", "x-akamai": { "file-path": "errors/400-verify-op.yaml" } } }, "summary": "Verify existing operations", "tags": [ "Verify operations" ] }, "x-akamai": { "file-path": "paths/verify-operations.yaml", "path-info": "/verify-operations" } } }, "servers": [ { "url": "https://{hostname}/api-definitions/v2" } ], "tags": [], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } }