openapi: 3.0.0 info: title: 'Akamai: API Endpoint Definition Access tokens Endpoints API' version: '2' license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://{hostname}/api-definitions/v2 tags: - name: Endpoints paths: /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. operationId: post-endpoints summary: Register an endpoint tags: - Endpoints externalDocs: description: See documentation for this operation in Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference/post-endpoints requestBody: required: true content: application/json: example: apiEndPointName: Bookstore API apiEndPointScheme: http/https apiGatewayEnabled: true basePath: /bookstore consumeType: any contractId: C-0N7RAC71 description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. groupId: 44681 isGraphQL: false lockVersion: 0 apiCategoryIds: - 2 - 7 apiEndPointHosts: - bookstore.api.akamai.com 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 securityScheme: securitySchemeType: apikey securitySchemeDetail: apiKeyLocation: header apiKeyName: apikey apiResources: - apiResourceName: books description: A book item within the bookstore API. resourcePath: /books/{bookId} apiResourceMethods: - apiResourceMethod: GET apiParameters: - apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string array: false response: false - apiResourceMethod: POST apiParameters: - apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterType: string array: false response: false apiParameterRestriction: lengthRestriction: lengthMax: 15 lengthMin: 3 schema: additionalProperties: false description: Contains information about an endpoint and its associated resources. type: object required: - apiEndPointName - apiEndPointHosts - groupId - contractId - lockVersion properties: akamaiSecurityRestrictions: additionalProperties: false description: Contains information about the Kona Site Defender security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a Kona Site Defender customer. nullable: true type: object properties: ALLOW_ONLY_SPEC_UNDEFINED_METHODS: description: Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_BODY_PARAMS: description: Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_COOKIE_PARAMS: description: Whether the API allows for requests with undefined parameters in cookies. These booleans override members in the Method object. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_HEADER_PARAMS: description: Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_DELETE: description: Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_GET: description: Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_HEAD: description: Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_OPTIONS: description: Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PATCH: description: Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_POST: description: Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PUT: description: Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_PARAMS: description: Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_QUERY_PARAMS: description: Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_RESOURCES: description: Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_SPEC_PARAMS: description: Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 MAX_BODY_SIZE: description: The maximum allowed size of a request body. nullable: true type: integer MAX_DOC_DEPTH: description: The maximum depth of nested data elements allowed in a request body. nullable: true type: integer MAX_ELEMENT_NAME_LENGTH: description: The maximum length of an XML element name or JSON object key name allowed in a request body. nullable: true type: integer MAX_INTEGER_VALUE: description: The maximum integer value allowed in a request body. nullable: true type: integer MAX_JSONXML_ELEMENT: description: The maximum number of XML elements, JSON object keys, or array items allowed in a request body. nullable: true type: integer MAX_STRING_LENGTH: description: The maximum length of any string value in a request body. nullable: true type: integer POSITIVE_SECURITY_ENABLED: description: Whether to enforce the API request body and resource constraints as allowlists in your KSD security policies. Either `1` for enabled security constraints, or `0` for disabled. type: integer enum: - 0 - 1 POSITIVE_SECURITY_VERSION: description: Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API. nullable: true type: integer enum: - 1 - 2 RESPONSE_RESTRICTIONS_ENABLED: description: When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`. type: integer enum: - 0 - 1 apiCategoryIds: description: The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints. nullable: true type: array items: type: integer apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint. minItems: 1 type: array items: type: string apiEndPointId: description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' nullable: true readOnly: true type: integer apiEndPointLocked: description: Whether the endpoint version is read-only. example: '{{apiEndPointLocked}}' nullable: true readOnly: true type: boolean apiEndPointName: description: The name of the endpoint, unique within the account. example: '{{apiEndPointName}}' type: string apiEndPointScheme: description: The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both. example: '{{apiEndPointScheme}}' nullable: true type: string enum: - http - https - http/https apiEndPointVersion: description: The unique identifier for the endpoint version. example: '{{apiEndPointVersion}}' nullable: true readOnly: true type: integer apiGatewayEnabled: default: true description: Whether the API Gateway product should be enabled for the endpoint. If `null`, the member is set to `true`. example: '{{apiGatewayEnabled}}' nullable: true type: boolean apiResources: description: The list of resources assigned to the endpoint. nullable: true type: array items: additionalProperties: false description: Contains information about a resource assigned to an endpoint. type: object required: - apiResourceName - resourcePath properties: apiResourceClonedFromId: description: For cloned resources, the unique identifier for the source resource. nullable: true type: integer apiResourceId: description: The unique identifier for the resource. type: integer apiResourceLogicId: description: The unique identifier for the resource across all endpoint versions. type: integer apiResourceMethodNameLists: description: The list of HTTP methods the resource may respond to. type: array items: type: string apiResourceMethods: description: The list of HTTP methods the resource may respond to. type: array items: additionalProperties: false description: Contains information about an HTTP method to which a resource may respond. type: object required: - apiResourceMethod properties: apiParameters: description: The list of parameter objects assigned to the method. nullable: true type: array items: additionalProperties: false description: Contains information about a method's parameter. type: object required: - apiParameterName - apiParameterType - apiParameterRequired - apiParameterLocation properties: apiChildParameters: description: The collection of child JSON members or XML elements for JSON or XML body type parameters. type: array items: description: A further nested endpoint object. type: object x-akamai: file-path: schemas/apiParameterDto-nested.yaml apiParamLogicId: description: The unique identifier for the parameter across all endpoint versions. readOnly: true type: integer apiParameterContentType: description: The content type of the parameter. Only applicable for top level body parameters. type: string enum: - json - xml - urlencoded - json/xml - any - none apiParameterId: description: The unique identifier for the parameter. readOnly: true type: integer apiParameterLocation: description: The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter. type: string enum: - query - body - header - path - cookie apiParameterName: description: The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`. type: string apiParameterNotes: description: The description to clarify the parameter's function. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`. nullable: true type: string apiParameterRequired: description: Specifies whether the API user needs to specify the parameter. If the corresponding `apiParameterLocation` is `path`, set this member to `true`. type: boolean apiParameterRestriction: additionalProperties: false description: Contains information about restrictions and XML representation rules specified for the parameter. nullable: true type: object properties: arrayRestriction: additionalProperties: false description: Contains information about array restrictions for array type parameters. Define this object only if you enabled the corresponding `array` member. nullable: true type: object properties: collectionFormat: default: csv description: The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance. type: string enum: - csv - ssv - tsv - pipes - multi maxItems: description: The maximum allowed number of array items. type: integer minItems: description: The minimum allowed number of array items. type: integer uniqueItems: description: Whether the array contains only unique items. type: boolean lengthRestriction: additionalProperties: false description: Contains information about length restrictions for string type parameters. nullable: true type: object properties: lengthMax: description: The maximum allowed number of characters in the string. nullable: true type: integer lengthMin: description: The minimum allowed number of characters in the string. nullable: true type: integer numberRangeRestriction: additionalProperties: false description: Contains information about range restrictions for number type parameters. nullable: true type: object properties: numberRangeMax: description: The maximum range restriction. nullable: true type: number numberRangeMin: description: The minimum range restriction. nullable: true type: number rangeRestriction: additionalProperties: false description: Contains information about range restrictions for integer type parameters. nullable: true type: object properties: rangeMax: description: The maximum range restriction. nullable: true type: integer rangeMin: description: The minimum range restriction. nullable: true type: integer responseRestriction: additionalProperties: false type: object properties: maxBodySize: description: Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size. type: string enum: - SIZE_6K - SIZE_8K - SIZE_12K - NO_LIMIT statusCodes: description: The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body. nullable: true type: array items: type: integer xmlConversionRule: additionalProperties: false description: Contains information about an XML representation of a JSON-encoded parameter. nullable: true type: object properties: attribute: default: false description: Whether the parameter should be represented as an attribute. type: boolean name: description: The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition. type: string namespace: description: The XML namespace. type: string prefix: description: The prefix for the XML namespace. type: string wrapped: default: false description: Whether the parameter should be wrapped in a parent XML element. type: boolean x-akamai: file-path: schemas/xmlRestrictionDto.yaml apiParameterType: description: The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects. type: string enum: - string - integer - number - boolean - json/xml apiResourceMethParamId: description: The unique identifier for the parameter's parent method. nullable: true readOnly: true type: integer array: description: Whether the parameter can express more than one value. This member is only applicable for `apiChildParameters` that you can specify if the corresponding `apiParameterLocation` is `body` and the `apiParameterType` is `json/xml`. If you enable this, also define the `arrayRestriction` member. type: boolean pathParamLocationId: description: The index of a segment that includes a path parameter in a resource path. For example, given a path `\books\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`. nullable: true type: number response: description: Whether the parameter is within a response type. type: boolean x-akamai: file-path: schemas/apiParameterDto.yaml apiResourceMethod: description: The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`. type: string enum: - GET - PUT - POST - DELETE - HEAD - PATCH - OPTIONS apiResourceMethodId: description: The unique identifier for the resource's allowed method. nullable: true readOnly: true type: integer apiResourceMethodLogicId: description: The unique identifier for the resource's method across all endpoint versions. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiMethodParametersDto.yaml apiResourceName: description: The name of the resource. type: string createDate: description: The ISO 6801 timestamp indicating when you created the resource. format: date-time type: string createdBy: description: The identifier for the user who created the resource. type: string description: description: The description to clarify the resource's function within the API. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. type: string link: description: The location of the navigable resource within this API, for use by API clients. nullable: true type: string lockVersion: description: The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. type: number private: description: Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key. type: boolean resourcePath: description: The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` member in the corresponding parameter definition matches the name that you specified in the resource path. type: string updateDate: description: The ISO 6801 timestamp indicating when you last modified the resource. format: date-time type: string updatedBy: description: The identifier for the user who last modified the resource. type: string x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml apiSource: description: Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`. example: '{{apiSource}}' nullable: true type: string enum: - USER - API_DISCOVERY apiVersionInfo: additionalProperties: false description: Contains information about a major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai. nullable: true type: object required: - location properties: location: description: The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter. type: string enum: - HEADER - BASE_PATH - QUERY parameterName: description: The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` member is either `HEADER` or `QUERY`. type: string value: description: The expected API version value in an incoming request. type: string x-akamai: file-path: schemas/apiVersionInfo.yaml availableActions: description: The collection of available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2). minItems: 0 nullable: true readOnly: true type: array items: type: string enum: - DELETE - CLONE_ENDPOINT - COMPARE_ENDPOINT - COMPARE_AAG_SETTINGS - COMPARE_RAPID_SETTINGS - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING - ACTIVATE_ON_PRODUCTION - DEACTIVATE_ON_STAGING - DEACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - SHOW_ENDPOINT basePath: description: The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. example: '{{basePath}}' minLength: 0 nullable: true type: string caseSensitive: description: Whether the URLs and parameters within the endpoint are case sensitive. example: '{{caseSensitive}}' nullable: true type: boolean clonedFromVersion: description: For cloned endpoints, the unique identifier for the source endpoint version. example: '{{clonedFromVersion}}' nullable: true readOnly: true type: integer consumeType: description: The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string. example: '{{consumeType}}' nullable: true type: string enum: - none - json - xml - json/xml - any - urlencoded - json/urlencoded - xml/urlencoded - json/xml/urlencoded contractId: description: The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API. example: '{{contractId}}' nullable: true readOnly: true type: string createDate: description: The ISO 6801 timestamp indicating when you created the endpoint. example: '{{createDate}}' format: date-time nullable: true readOnly: true type: string createdBy: description: The identifier for the user who created the endpoint. example: '{{createdBy}}' nullable: true readOnly: true type: string description: description: The description of the endpoint. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. example: '{{description}}' nullable: true type: string discoveredPiiIds: description: The collection of personally identifiable information (PII) in your API parameters discovered by the network. nullable: true type: array items: type: integer endpointHidden: description: Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation. example: '{{endpointHidden}}' nullable: true readOnly: true type: boolean groupId: description: The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API. example: '{{groupId}}' nullable: true readOnly: true type: integer isGraphQL: description: Whether the endpoint uses GraphQL to deliver structured content to clients. example: '{{isGraphQL}}' type: boolean lockVersion: description: The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. example: '{{lockVersion}}' readOnly: true type: integer matchPathSegmentParam: default: true description: Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`. example: '{{matchPathSegmentParam}}' nullable: true type: boolean positiveConstrainsEnabled: description: Specifies whether the KSD firewall policies are enabled for the endpoint. example: '{{positiveConstrainsEnabled}}' nullable: true type: boolean productionStatus: description: The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. example: '{{productionStatus}}' nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED productionVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the production network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml protectedByApiKey: description: Whether you enabled API key protection for the endpoint version by making the version private. example: '{{protectedByApiKey}}' readOnly: true type: boolean responseConstraintsEnabled: description: Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled. example: '{{responseConstraintsEnabled}}' nullable: true readOnly: true type: boolean securityScheme: additionalProperties: false description: Contains information about the key with which users may access the endpoint. nullable: true type: object properties: securitySchemeDetail: additionalProperties: false description: Contains information about the location of the API key. type: object properties: apiKeyLocation: description: The location of the API key in incoming requests, either `cookie`, `header`, or `query` parameter. type: string enum: - cookie - header - query apiKeyName: description: The name of the header, query parameter, or cookie where you located the API key. type: string securitySchemeType: description: The type of security scheme implemented for the endpoint. The only valid value is `apikey`. type: string enum: - apikey source: additionalProperties: false description: Contains information about the import file used to create the endpoint. nullable: true readOnly: true type: object properties: apiVersion: description: The major version of the API defined in the import file. nullable: true readOnly: true type: string specificationVersion: description: The version of the import file's specification. example: 3.0.0 nullable: true readOnly: true type: string type: description: The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`. nullable: true readOnly: true type: string enum: - SWAGGER - RAML x-akamai: file-path: schemas/apiEndpointSourceDto.yaml stagingStatus: description: The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. example: '{{stagingStatus}}' nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the staging network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml updateDate: description: The ISO 6801 timestamp indicating when you last modified the endpoint. example: '{{updateDate}}' format: date-time nullable: true readOnly: true type: string updatedBy: description: The identifier for the user who last modified the endpoint. example: '{{updatedBy}}' nullable: true readOnly: true type: string versionHidden: description: Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation. example: '{{versionHidden}}' nullable: true readOnly: true type: boolean versionNumber: description: The endpoint version number. example: '{{versionNumber}}' nullable: true type: integer x-akamai: file-path: schemas/apiEndpointWithResourceDto-recurse.yaml responses: '201': description: New resource successfully created. content: application/json: example: akamaiSecurityRestrictions: null apiEndPointId: 492375 apiEndPointLocked: false apiEndPointName: Bookstore API apiEndPointScheme: http/https apiEndPointVersion: 574127 apiGatewayEnabled: true basePath: /bookstore caseSensitive: true clonedFromVersion: null consumeType: any contractId: C-0N7RAC71 createDate: 2019-06-12T13:06:52+0000 createdBy: jkowalski description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. endpointHidden: false graphQL: false groupId: 44681 isGraphQL: false lockVersion: 0 positiveConstrainsEnabled: null productionStatus: null protectedByApiKey: true responseConstraintsEnabled: false source: null stagingStatus: null updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin versionHidden: false versionNumber: 1 apiCategoryIds: - 2 - 7 apiEndPointHosts: - bookstore.api.akamai.com availableActions: - DELETE - CLONE_ENDPOINT - ACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING discoveredPiiIds: - 455976 productionVersion: lastError: null status: null timestamp: null versionNumber: null securityScheme: securitySchemeType: apikey securitySchemeDetail: apiKeyLocation: header apiKeyName: apikey stagingVersion: lastError: null status: null timestamp: null versionNumber: null apiResources: - apiResourceClonedFromId: null apiResourceId: 2926712 apiResourceLogicId: 118435 apiResourceName: books createDate: 2019-06-12T13:06:52+0000 createdBy: jperez description: A book item within the bookstore API. link: null lockVersion: 0 private: false resourcePath: /books/{bookId} updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin apiResourceMethods: - apiResourceMethod: GET apiResourceMethodId: 341591 apiResourceMethodLogicId: 184404 apiParameters: - apiParamLogicId: 578116 apiParameterId: 1212945 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string apiResourceMethParamId: 494448 array: false pathParamLocationId: null response: false apiChildParameters: [] - apiResourceMethod: POST apiResourceMethodId: 341592 apiResourceMethodLogicId: 184405 apiParameters: - apiParamLogicId: 578117 apiParameterId: 1212946 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterType: string apiResourceMethParamId: 494449 array: false pathParamLocationId: null apiChildParameters: [] apiParameterRestriction: apiParameterType: json array: true numberRangeRestriction: null rangeRestriction: null response: true xmlConversionRule: null arrayRestriction: maxItems: 200 minItems: 100 responseRestriction: maxBodySize: SIZE_6K statusCodes: - 200 - 201 schema: additionalProperties: false description: Contains information about an endpoint and its associated resources. type: object required: - apiEndPointName - apiEndPointHosts - groupId - contractId - lockVersion properties: akamaiSecurityRestrictions: additionalProperties: false description: Contains information about the Kona Site Defender security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a Kona Site Defender customer. nullable: true type: object properties: ALLOW_ONLY_SPEC_UNDEFINED_METHODS: description: Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_BODY_PARAMS: description: Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_COOKIE_PARAMS: description: Whether the API allows for requests with undefined parameters in cookies. These booleans override members in the Method object. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_HEADER_PARAMS: description: Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_DELETE: description: Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_GET: description: Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_HEAD: description: Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_OPTIONS: description: Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PATCH: description: Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_POST: description: Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PUT: description: Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_PARAMS: description: Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_QUERY_PARAMS: description: Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_RESOURCES: description: Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_SPEC_PARAMS: description: Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 MAX_BODY_SIZE: description: The maximum allowed size of a request body. nullable: true type: integer MAX_DOC_DEPTH: description: The maximum depth of nested data elements allowed in a request body. nullable: true type: integer MAX_ELEMENT_NAME_LENGTH: description: The maximum length of an XML element name or JSON object key name allowed in a request body. nullable: true type: integer MAX_INTEGER_VALUE: description: The maximum integer value allowed in a request body. nullable: true type: integer MAX_JSONXML_ELEMENT: description: The maximum number of XML elements, JSON object keys, or array items allowed in a request body. nullable: true type: integer MAX_STRING_LENGTH: description: The maximum length of any string value in a request body. nullable: true type: integer POSITIVE_SECURITY_ENABLED: description: Whether to enforce the API request body and resource constraints as allowlists in your KSD security policies. Either `1` for enabled security constraints, or `0` for disabled. type: integer enum: - 0 - 1 POSITIVE_SECURITY_VERSION: description: Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API. nullable: true type: integer enum: - 1 - 2 RESPONSE_RESTRICTIONS_ENABLED: description: When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`. type: integer enum: - 0 - 1 apiCategoryIds: description: The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints. nullable: true type: array items: type: integer apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint. minItems: 1 type: array items: type: string apiEndPointId: description: The unique identifier for the endpoint. nullable: true readOnly: true type: integer apiEndPointLocked: description: Whether the endpoint version is read-only. nullable: true readOnly: true type: boolean apiEndPointName: description: The name of the endpoint, unique within the account. type: string apiEndPointScheme: description: The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both. nullable: true type: string enum: - http - https - http/https apiEndPointVersion: description: The unique identifier for the endpoint version. nullable: true readOnly: true type: integer apiGatewayEnabled: default: true description: Whether the API Gateway product should be enabled for the endpoint. If `null`, the member is set to `true`. nullable: true type: boolean apiResources: description: The list of resources assigned to the endpoint. nullable: true type: array items: additionalProperties: false description: Contains information about a resource assigned to an endpoint. type: object required: - apiResourceName - resourcePath properties: apiResourceClonedFromId: description: For cloned resources, the unique identifier for the source resource. nullable: true type: integer apiResourceId: description: The unique identifier for the resource. type: integer apiResourceLogicId: description: The unique identifier for the resource across all endpoint versions. type: integer apiResourceMethodNameLists: description: The list of HTTP methods the resource may respond to. type: array items: type: string apiResourceMethods: description: The list of HTTP methods the resource may respond to. type: array items: additionalProperties: false description: Contains information about an HTTP method to which a resource may respond. type: object required: - apiResourceMethod properties: apiParameters: description: The list of parameter objects assigned to the method. nullable: true type: array items: additionalProperties: false description: Contains information about a method's parameter. type: object required: - apiParameterName - apiParameterType - apiParameterRequired - apiParameterLocation properties: apiChildParameters: description: The collection of child JSON members or XML elements for JSON or XML body type parameters. type: array items: description: A further nested endpoint object. type: object x-akamai: file-path: schemas/apiParameterDto-nested.yaml apiParamLogicId: description: The unique identifier for the parameter across all endpoint versions. readOnly: true type: integer apiParameterContentType: description: The content type of the parameter. Only applicable for top level body parameters. type: string enum: - json - xml - urlencoded - json/xml - any - none apiParameterId: description: The unique identifier for the parameter. readOnly: true type: integer apiParameterLocation: description: The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter. type: string enum: - query - body - header - path - cookie apiParameterName: description: The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`. type: string apiParameterNotes: description: The description to clarify the parameter's function. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`. nullable: true type: string apiParameterRequired: description: Specifies whether the API user needs to specify the parameter. If the corresponding `apiParameterLocation` is `path`, set this member to `true`. type: boolean apiParameterRestriction: additionalProperties: false description: Contains information about restrictions and XML representation rules specified for the parameter. nullable: true type: object properties: arrayRestriction: additionalProperties: false description: Contains information about array restrictions for array type parameters. Define this object only if you enabled the corresponding `array` member. nullable: true type: object properties: collectionFormat: default: csv description: The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance. type: string enum: - csv - ssv - tsv - pipes - multi maxItems: description: The maximum allowed number of array items. type: integer minItems: description: The minimum allowed number of array items. type: integer uniqueItems: description: Whether the array contains only unique items. type: boolean lengthRestriction: additionalProperties: false description: Contains information about length restrictions for string type parameters. nullable: true type: object properties: lengthMax: description: The maximum allowed number of characters in the string. nullable: true type: integer lengthMin: description: The minimum allowed number of characters in the string. nullable: true type: integer numberRangeRestriction: additionalProperties: false description: Contains information about range restrictions for number type parameters. nullable: true type: object properties: numberRangeMax: description: The maximum range restriction. nullable: true type: number numberRangeMin: description: The minimum range restriction. nullable: true type: number rangeRestriction: additionalProperties: false description: Contains information about range restrictions for integer type parameters. nullable: true type: object properties: rangeMax: description: The maximum range restriction. nullable: true type: integer rangeMin: description: The minimum range restriction. nullable: true type: integer responseRestriction: additionalProperties: false type: object properties: maxBodySize: description: Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size. type: string enum: - SIZE_6K - SIZE_8K - SIZE_12K - NO_LIMIT statusCodes: description: The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body. nullable: true type: array items: type: integer xmlConversionRule: additionalProperties: false description: Contains information about an XML representation of a JSON-encoded parameter. nullable: true type: object properties: attribute: default: false description: Whether the parameter should be represented as an attribute. type: boolean name: description: The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition. type: string namespace: description: The XML namespace. type: string prefix: description: The prefix for the XML namespace. type: string wrapped: default: false description: Whether the parameter should be wrapped in a parent XML element. type: boolean x-akamai: file-path: schemas/xmlRestrictionDto.yaml apiParameterType: description: The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects. type: string enum: - string - integer - number - boolean - json/xml apiResourceMethParamId: description: The unique identifier for the parameter's parent method. nullable: true readOnly: true type: integer array: description: Whether the parameter can express more than one value. This member is only applicable for `apiChildParameters` that you can specify if the corresponding `apiParameterLocation` is `body` and the `apiParameterType` is `json/xml`. If you enable this, also define the `arrayRestriction` member. type: boolean pathParamLocationId: description: The index of a segment that includes a path parameter in a resource path. For example, given a path `\books\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`. nullable: true type: number response: description: Whether the parameter is within a response type. type: boolean x-akamai: file-path: schemas/apiParameterDto.yaml apiResourceMethod: description: The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`. type: string enum: - GET - PUT - POST - DELETE - HEAD - PATCH - OPTIONS apiResourceMethodId: description: The unique identifier for the resource's allowed method. nullable: true readOnly: true type: integer apiResourceMethodLogicId: description: The unique identifier for the resource's method across all endpoint versions. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiMethodParametersDto.yaml apiResourceName: description: The name of the resource. type: string createDate: description: The ISO 6801 timestamp indicating when you created the resource. format: date-time type: string createdBy: description: The identifier for the user who created the resource. type: string description: description: The description to clarify the resource's function within the API. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. type: string link: description: The location of the navigable resource within this API, for use by API clients. nullable: true type: string lockVersion: description: The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. type: number private: description: Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key. type: boolean resourcePath: description: The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` member in the corresponding parameter definition matches the name that you specified in the resource path. type: string updateDate: description: The ISO 6801 timestamp indicating when you last modified the resource. format: date-time type: string updatedBy: description: The identifier for the user who last modified the resource. type: string x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml apiSource: description: Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`. nullable: true type: string enum: - USER - API_DISCOVERY apiVersionInfo: additionalProperties: false description: Contains information about a major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai. nullable: true type: object required: - location properties: location: description: The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter. type: string enum: - HEADER - BASE_PATH - QUERY parameterName: description: The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` member is either `HEADER` or `QUERY`. type: string value: description: The expected API version value in an incoming request. type: string x-akamai: file-path: schemas/apiVersionInfo.yaml availableActions: description: The collection of available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2). minItems: 0 nullable: true readOnly: true type: array items: type: string enum: - DELETE - CLONE_ENDPOINT - COMPARE_ENDPOINT - COMPARE_AAG_SETTINGS - COMPARE_RAPID_SETTINGS - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING - ACTIVATE_ON_PRODUCTION - DEACTIVATE_ON_STAGING - DEACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - SHOW_ENDPOINT basePath: description: The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. minLength: 0 nullable: true type: string caseSensitive: description: Whether the URLs and parameters within the endpoint are case sensitive. nullable: true type: boolean clonedFromVersion: description: For cloned endpoints, the unique identifier for the source endpoint version. nullable: true readOnly: true type: integer consumeType: description: The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string. nullable: true type: string enum: - none - json - xml - json/xml - any - urlencoded - json/urlencoded - xml/urlencoded - json/xml/urlencoded contractId: description: The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API. nullable: true readOnly: true type: string createDate: description: The ISO 6801 timestamp indicating when you created the endpoint. format: date-time nullable: true readOnly: true type: string createdBy: description: The identifier for the user who created the endpoint. nullable: true readOnly: true type: string description: description: The description of the endpoint. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. nullable: true type: string discoveredPiiIds: description: The collection of personally identifiable information (PII) in your API parameters discovered by the network. nullable: true type: array items: type: integer endpointHidden: description: Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation. nullable: true readOnly: true type: boolean groupId: description: The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API. nullable: true readOnly: true type: integer isGraphQL: description: Whether the endpoint uses GraphQL to deliver structured content to clients. type: boolean lockVersion: description: The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. readOnly: true type: integer matchPathSegmentParam: default: true description: Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`. nullable: true type: boolean positiveConstrainsEnabled: description: Specifies whether the KSD firewall policies are enabled for the endpoint. nullable: true type: boolean productionStatus: description: The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED productionVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the production network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml protectedByApiKey: description: Whether you enabled API key protection for the endpoint version by making the version private. readOnly: true type: boolean responseConstraintsEnabled: description: Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled. nullable: true readOnly: true type: boolean securityScheme: additionalProperties: false description: Contains information about the key with which users may access the endpoint. nullable: true type: object properties: securitySchemeDetail: additionalProperties: false description: Contains information about the location of the API key. type: object properties: apiKeyLocation: description: The location of the API key in incoming requests, either `cookie`, `header`, or `query` parameter. type: string enum: - cookie - header - query apiKeyName: description: The name of the header, query parameter, or cookie where you located the API key. type: string securitySchemeType: description: The type of security scheme implemented for the endpoint. The only valid value is `apikey`. type: string enum: - apikey source: additionalProperties: false description: Contains information about the import file used to create the endpoint. nullable: true readOnly: true type: object properties: apiVersion: description: The major version of the API defined in the import file. nullable: true readOnly: true type: string specificationVersion: description: The version of the import file's specification. example: 3.0.0 nullable: true readOnly: true type: string type: description: The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`. nullable: true readOnly: true type: string enum: - SWAGGER - RAML x-akamai: file-path: schemas/apiEndpointSourceDto.yaml stagingStatus: description: The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the staging network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml updateDate: description: The ISO 6801 timestamp indicating when you last modified the endpoint. format: date-time nullable: true readOnly: true type: string updatedBy: description: The identifier for the user who last modified the endpoint. nullable: true readOnly: true type: string versionHidden: description: Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation. nullable: true readOnly: true type: boolean versionNumber: description: The endpoint version number. nullable: true type: integer x-akamai: file-path: schemas/apiEndpointWithResourceDto-recurse.yaml headers: Location: description: Relative URL for the created API endpoint. schema: type: string '400': description: Invalid data input. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '403': description: The system denies user access to the contract and group. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string 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. operationId: get-endpoints summary: List endpoints tags: - Endpoints externalDocs: description: See documentation for this operation in Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference/get-endpoints responses: '200': description: Lists API Endpoints you can access. content: application/json: example: page: 8 pageSize: 1 totalSize: 15 apiEndPoints: - apiEndPointId: 574127 apiEndPointLocked: false apiEndPointName: Bookstore API Premium apiEndPointScheme: http/https basePath: /bookstore-premium clonedFromVersion: 1 consumeType: any contractId: K-0N7RAK71 createDate: 2019-06-12T13:06:52+0000 createdBy: jsmith description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. endpointHidden: true groupId: 44681 positiveConstrainsEnabled: true protectedByApiKey: true responseConstraintsEnabled: true updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin versionHidden: true versionNumber: 2 apiCategoryIds: [] apiEndPointHosts: - bookstore.api.akamai.com availableActions: - CLONE_ENDPOINT - SHOW_ENDPOINT - COMPARE_ENDPOINT - ACTIVATE_ON_STAGING - ACTIVATE_ON_PRODUCTION pii: types: - PERSONAL_EMAIL productionVersion: status: null versionNumber: null stagingVersion: status: null versionNumber: null apiResourceBaseInfo: - apiResourceClonedFromId: null apiResourceId: 2926712 apiResourceLogicId: 118435 apiResourceName: /books/{bookId} createDate: 2019-06-12T13:06:52+0000 createdBy: tyamada 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 links: - href: /api-definitions/v2/endpoints?pageSize=2&page=8 rel: self - href: /api-definitions/v2/endpoints?pageSize=2&page=9 rel: next - href: /api-definitions/v2/endpoints?pageSize=2&page=7 rel: previous schema: additionalProperties: false description: Contains information about a collection of requested endpoints. type: object properties: apiEndPoints: description: The collection of the returned endpoint objects. type: array items: additionalProperties: false type: object required: - apiEndPointName properties: apiCategoryIds: description: The category identifiers that apply to this endpoint. The value is `null` for uncategorized endpoints. type: array items: type: integer apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname to activate the endpoint. type: array items: type: string 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. type: string enum: - http - https - http/https apiEndPointVersion: description: The unique identifier for the endpoint version. type: integer apiResourceBaseInfo: description: The collection of resource objects assigned to the endpoint. type: array items: additionalProperties: false type: object 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 6801 timestamp indicating when you created the resource. format: date-time type: string createdBy: description: The identifier for the user who created the resource. type: string description: description: The description to clarify the resource's function within the API. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`. 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 resourcePath: description: The URL path relative to the hostnames on which the resource resides. type: string updateDate: description: The ISO 6801 timestamp indicating when you last modified the resource. format: date-time type: string updatedBy: description: The identifier for the user who last modified the resource. type: string apiVersionInfo: additionalProperties: false description: Contains information about a major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai. nullable: true type: object required: - location properties: location: description: The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter. type: string enum: - HEADER - BASE_PATH - QUERY parameterName: description: The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` member is either `HEADER` or `QUERY`. type: string value: description: The expected API version value in an incoming request. type: string x-akamai: file-path: schemas/apiVersionInfo.yaml availableActions: description: The collection of available actions that you can perform on the endpoint depending on its versions' activation status. type: array items: type: string enum: - DELETE - CLONE_ENDPOINT - COMPARE_ENDPOINT - COMPARE_AAG_SETTINGS - COMPARE_RAPID_SETTINGS - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING - ACTIVATE_ON_PRODUCTION - DEACTIVATE_ON_STAGING - DEACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - SHOW_ENDPOINT basePath: description: The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. 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`. type: string enum: - none - json - xml - json/xml - any 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 6801 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 member from the object, the JSON response reflects it as an empty string. 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)[ref:api-concepts] for more information. type: object properties: types: description: The PII type. Either `PERSONAL_EMAIL` or `CREDIT_OR_DEBIT_CARD_NUMBER`. type: array items: type: string enum: - PERSONAL_EMAIL - CREDIT_OR_DEBIT_CARD_NUMBER positiveConstrainsEnabled: description: Enables Kona Site Defender (KSD) firewall policies for the endpoint. type: boolean productionVersion: description: Contains information about an endpoint version's activation status on the production network. type: object responseConstraintsEnabled: description: Enables Kona Site Defender (KSD) firewall policies for the responses. type: boolean source: description: Contains information about the import file used to create the endpoint. nullable: true type: object stagingVersion: description: Contains information about an endpoint version's activation status on the staging network. type: object updateDate: description: The ISO 6801 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 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 x-akamai: file-path: schemas/apiEndpointListDto.yaml '403': description: You don't have permission to retrieve API endpoint list. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml parameters: - description: Whether to return only endpoints with personally identifiable information (PII). example: '{{piiOnly}}' in: query name: piiOnly required: false schema: example: false 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 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 type: integer x-akamai: file-path: parameters/pageSize-query.yaml - description: Filters endpoints by the specified `apiCategoryName`, including the `__UNCATEGORIZED__` keyword. example: '{{category}}' in: query name: category schema: 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: type: string x-akamai: file-path: parameters/contains-query.yaml - description: __Enum__ The field to sort endpoints by, either the API `name` (corresponding to the `apiEndPointName` member) or `updateDate`. example: '{{sortBy}}' in: query name: sortBy schema: default: name type: string enum: - name - updateDate x-akamai: file-path: parameters/sortBy-query.yaml - description: __Enum__ The sort order, either `desc` for descending or the default `asc` for ascending. example: '{{sortOrder}}' in: query name: sortOrder schema: type: string enum: - asc - desc x-akamai: file-path: parameters/sortOrder-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: type: string enum: - ACTIVATED_FIRST - LAST_UPDATED x-akamai: file-path: parameters/versionPreference-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: type: string enum: - ALL - ONLY_VISIBLE - ONLY_HIDDEN 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: type: string x-akamai: file-path: parameters/contractId-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: type: integer x-akamai: file-path: parameters/groupId-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 /endpoints/cloneEndpoint: post: description: Creates an endpoint as a clone from the specified source endpoint ID and version. operationId: post-endpoint-clone summary: Clone an endpoint tags: - Endpoints 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 requestBody: required: true content: application/json: example: apiEndPointId: 492375 apiEndPointName: Bookstore API Premium apiGatewayEnabled: true basePath: /bookstore-premium contractId: K-0N7RAK7 groupId: 44680 versionNumber: 1 apiEndPointHosts: - bookstore.api.akamai.com schema: additionalProperties: false description: Contains information about an endpoint to clone. type: object required: - contractId - groupId - apiEndPointName - basePath - apiEndPointHosts properties: apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint. type: array items: type: string 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 x-akamai: file-path: schemas/apiEndpointCloneDto.yaml responses: '200': description: Created API Endpoint. content: application/json: example: akamaiSecurityRestrictions: null apiEndPointId: 492375 apiEndPointLocked: false apiEndPointName: Bookstore API Premium apiEndPointScheme: http/https apiEndPointVersion: 574127 basePath: /bookstore-premium caseSensitive: true clonedFromVersion: 1 consumeType: any contractId: K-0N7RAK71 createDate: 2019-06-12T13:06:52+0000 createdBy: jkowalski description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. endpointHidden: false graphQL: false groupId: 44681 isGraphQL: false lockVersion: 2 positiveConstrainsEnabled: null productionStatus: null protectedByApiKey: true source: null stagingStatus: null updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin versionHidden: false versionNumber: 2 apiCategoryIds: - 2 - 7 apiEndPointHosts: - bookstore.api.akamai.com availableActions: - DELETE - CLONE_ENDPOINT - ACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING productionVersion: lastError: null status: null timestamp: null versionNumber: null securityScheme: securitySchemeType: apikey securitySchemeDetail: apiKeyLocation: header apiKeyName: apikey stagingVersion: lastError: null status: null timestamp: null versionNumber: null apiResources: - apiResourceClonedFromId: null apiResourceId: 2926712 apiResourceLogicId: 118435 apiResourceName: books createDate: 2019-06-12T13:06:52+0000 createdBy: jkowalski description: A book item within the bookstore API. link: null lockVersion: 2 private: false resourcePath: /books/{bookId} updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin apiResourceMethods: - apiResourceMethod: GET apiResourceMethodId: 341591 apiResourceMethodLogicId: 184404 apiParameters: - apiParamLogicId: 578116 apiParameterId: 1212945 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string apiResourceMethParamId: 494448 array: false pathParamLocationId: null apiChildParameters: [] - apiResourceMethod: POST apiResourceMethodId: 341592 apiResourceMethodLogicId: 184405 apiParameters: - apiParamLogicId: 578117 apiParameterContentType: json apiParameterId: 1212946 apiParameterLocation: body apiParameterName: books apiParameterNotes: null apiParameterRequired: true apiParameterType: string apiResourceMethParamId: 494449 array: true pathParamLocationId: null apiChildParameters: [] apiParameterRestriction: arrayRestriction: null numberRangeRestriction: null rangeRestriction: null xmlConversionRule: null lengthRestriction: lengthMax: 15 lengthMin: 3 schema: additionalProperties: false description: Contains information about an endpoint and its associated resources. type: object required: - apiEndPointName - apiEndPointHosts - groupId - contractId - lockVersion properties: akamaiSecurityRestrictions: additionalProperties: false description: Contains information about the Kona Site Defender security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a Kona Site Defender customer. nullable: true type: object properties: ALLOW_ONLY_SPEC_UNDEFINED_METHODS: description: Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_BODY_PARAMS: description: Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_COOKIE_PARAMS: description: Whether the API allows for requests with undefined parameters in cookies. These booleans override members in the Method object. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_HEADER_PARAMS: description: Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_DELETE: description: Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_GET: description: Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_HEAD: description: Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_OPTIONS: description: Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PATCH: description: Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_POST: description: Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PUT: description: Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_PARAMS: description: Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_QUERY_PARAMS: description: Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_RESOURCES: description: Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_SPEC_PARAMS: description: Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 MAX_BODY_SIZE: description: The maximum allowed size of a request body. nullable: true type: integer MAX_DOC_DEPTH: description: The maximum depth of nested data elements allowed in a request body. nullable: true type: integer MAX_ELEMENT_NAME_LENGTH: description: The maximum length of an XML element name or JSON object key name allowed in a request body. nullable: true type: integer MAX_INTEGER_VALUE: description: The maximum integer value allowed in a request body. nullable: true type: integer MAX_JSONXML_ELEMENT: description: The maximum number of XML elements, JSON object keys, or array items allowed in a request body. nullable: true type: integer MAX_STRING_LENGTH: description: The maximum length of any string value in a request body. nullable: true type: integer POSITIVE_SECURITY_ENABLED: description: Whether to enforce the API request body and resource constraints as allowlists in your KSD security policies. Either `1` for enabled security constraints, or `0` for disabled. type: integer enum: - 0 - 1 POSITIVE_SECURITY_VERSION: description: Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API. nullable: true type: integer enum: - 1 - 2 RESPONSE_RESTRICTIONS_ENABLED: description: When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`. type: integer enum: - 0 - 1 apiCategoryIds: description: The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints. nullable: true type: array items: type: integer apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint. minItems: 1 type: array items: type: string apiEndPointId: description: The unique identifier for the endpoint. nullable: true readOnly: true type: integer apiEndPointLocked: description: Whether the endpoint version is read-only. nullable: true readOnly: true type: boolean apiEndPointName: description: The name of the endpoint, unique within the account. type: string apiEndPointScheme: description: The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both. nullable: true type: string enum: - http - https - http/https apiEndPointVersion: description: The unique identifier for the endpoint version. nullable: true readOnly: true type: integer apiGatewayEnabled: default: true description: Whether the API Gateway product should be enabled for the endpoint. If `null`, the member is set to `true`. nullable: true type: boolean apiResources: description: The list of resources assigned to the endpoint. nullable: true type: array items: additionalProperties: false description: Contains information about a resource assigned to an endpoint. type: object required: - apiResourceName - resourcePath properties: apiResourceClonedFromId: description: For cloned resources, the unique identifier for the source resource. nullable: true type: integer apiResourceId: description: The unique identifier for the resource. type: integer apiResourceLogicId: description: The unique identifier for the resource across all endpoint versions. type: integer apiResourceMethodNameLists: description: The list of HTTP methods the resource may respond to. type: array items: type: string apiResourceMethods: description: The list of HTTP methods the resource may respond to. type: array items: additionalProperties: false description: Contains information about an HTTP method to which a resource may respond. type: object required: - apiResourceMethod properties: apiParameters: description: The list of parameter objects assigned to the method. nullable: true type: array items: additionalProperties: false description: Contains information about a method's parameter. type: object required: - apiParameterName - apiParameterType - apiParameterRequired - apiParameterLocation properties: apiChildParameters: description: The collection of child JSON members or XML elements for JSON or XML body type parameters. type: array items: description: A further nested endpoint object. type: object x-akamai: file-path: schemas/apiParameterDto-nested.yaml apiParamLogicId: description: The unique identifier for the parameter across all endpoint versions. readOnly: true type: integer apiParameterContentType: description: The content type of the parameter. Only applicable for top level body parameters. type: string enum: - json - xml - urlencoded - json/xml - any - none apiParameterId: description: The unique identifier for the parameter. readOnly: true type: integer apiParameterLocation: description: The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter. type: string enum: - query - body - header - path - cookie apiParameterName: description: The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`. type: string apiParameterNotes: description: The description to clarify the parameter's function. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`. nullable: true type: string apiParameterRequired: description: Specifies whether the API user needs to specify the parameter. If the corresponding `apiParameterLocation` is `path`, set this member to `true`. type: boolean apiParameterRestriction: additionalProperties: false description: Contains information about restrictions and XML representation rules specified for the parameter. nullable: true type: object properties: arrayRestriction: additionalProperties: false description: Contains information about array restrictions for array type parameters. Define this object only if you enabled the corresponding `array` member. nullable: true type: object properties: collectionFormat: default: csv description: The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance. type: string enum: - csv - ssv - tsv - pipes - multi maxItems: description: The maximum allowed number of array items. type: integer minItems: description: The minimum allowed number of array items. type: integer uniqueItems: description: Whether the array contains only unique items. type: boolean lengthRestriction: additionalProperties: false description: Contains information about length restrictions for string type parameters. nullable: true type: object properties: lengthMax: description: The maximum allowed number of characters in the string. nullable: true type: integer lengthMin: description: The minimum allowed number of characters in the string. nullable: true type: integer numberRangeRestriction: additionalProperties: false description: Contains information about range restrictions for number type parameters. nullable: true type: object properties: numberRangeMax: description: The maximum range restriction. nullable: true type: number numberRangeMin: description: The minimum range restriction. nullable: true type: number rangeRestriction: additionalProperties: false description: Contains information about range restrictions for integer type parameters. nullable: true type: object properties: rangeMax: description: The maximum range restriction. nullable: true type: integer rangeMin: description: The minimum range restriction. nullable: true type: integer responseRestriction: additionalProperties: false type: object properties: maxBodySize: description: Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size. type: string enum: - SIZE_6K - SIZE_8K - SIZE_12K - NO_LIMIT statusCodes: description: The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body. nullable: true type: array items: type: integer xmlConversionRule: additionalProperties: false description: Contains information about an XML representation of a JSON-encoded parameter. nullable: true type: object properties: attribute: default: false description: Whether the parameter should be represented as an attribute. type: boolean name: description: The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition. type: string namespace: description: The XML namespace. type: string prefix: description: The prefix for the XML namespace. type: string wrapped: default: false description: Whether the parameter should be wrapped in a parent XML element. type: boolean x-akamai: file-path: schemas/xmlRestrictionDto.yaml apiParameterType: description: The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects. type: string enum: - string - integer - number - boolean - json/xml apiResourceMethParamId: description: The unique identifier for the parameter's parent method. nullable: true readOnly: true type: integer array: description: Whether the parameter can express more than one value. This member is only applicable for `apiChildParameters` that you can specify if the corresponding `apiParameterLocation` is `body` and the `apiParameterType` is `json/xml`. If you enable this, also define the `arrayRestriction` member. type: boolean pathParamLocationId: description: The index of a segment that includes a path parameter in a resource path. For example, given a path `\books\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`. nullable: true type: number response: description: Whether the parameter is within a response type. type: boolean x-akamai: file-path: schemas/apiParameterDto.yaml apiResourceMethod: description: The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`. type: string enum: - GET - PUT - POST - DELETE - HEAD - PATCH - OPTIONS apiResourceMethodId: description: The unique identifier for the resource's allowed method. nullable: true readOnly: true type: integer apiResourceMethodLogicId: description: The unique identifier for the resource's method across all endpoint versions. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiMethodParametersDto.yaml apiResourceName: description: The name of the resource. type: string createDate: description: The ISO 6801 timestamp indicating when you created the resource. format: date-time type: string createdBy: description: The identifier for the user who created the resource. type: string description: description: The description to clarify the resource's function within the API. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. type: string link: description: The location of the navigable resource within this API, for use by API clients. nullable: true type: string lockVersion: description: The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. type: number private: description: Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key. type: boolean resourcePath: description: The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` member in the corresponding parameter definition matches the name that you specified in the resource path. type: string updateDate: description: The ISO 6801 timestamp indicating when you last modified the resource. format: date-time type: string updatedBy: description: The identifier for the user who last modified the resource. type: string x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml apiSource: description: Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`. nullable: true type: string enum: - USER - API_DISCOVERY apiVersionInfo: additionalProperties: false description: Contains information about a major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai. nullable: true type: object required: - location properties: location: description: The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter. type: string enum: - HEADER - BASE_PATH - QUERY parameterName: description: The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` member is either `HEADER` or `QUERY`. type: string value: description: The expected API version value in an incoming request. type: string x-akamai: file-path: schemas/apiVersionInfo.yaml availableActions: description: The collection of available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2). minItems: 0 nullable: true readOnly: true type: array items: type: string enum: - DELETE - CLONE_ENDPOINT - COMPARE_ENDPOINT - COMPARE_AAG_SETTINGS - COMPARE_RAPID_SETTINGS - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING - ACTIVATE_ON_PRODUCTION - DEACTIVATE_ON_STAGING - DEACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - SHOW_ENDPOINT basePath: description: The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. minLength: 0 nullable: true type: string caseSensitive: description: Whether the URLs and parameters within the endpoint are case sensitive. nullable: true type: boolean clonedFromVersion: description: For cloned endpoints, the unique identifier for the source endpoint version. nullable: true readOnly: true type: integer consumeType: description: The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string. nullable: true type: string enum: - none - json - xml - json/xml - any - urlencoded - json/urlencoded - xml/urlencoded - json/xml/urlencoded contractId: description: The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API. nullable: true readOnly: true type: string createDate: description: The ISO 6801 timestamp indicating when you created the endpoint. format: date-time nullable: true readOnly: true type: string createdBy: description: The identifier for the user who created the endpoint. nullable: true readOnly: true type: string description: description: The description of the endpoint. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. nullable: true type: string discoveredPiiIds: description: The collection of personally identifiable information (PII) in your API parameters discovered by the network. nullable: true type: array items: type: integer endpointHidden: description: Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation. nullable: true readOnly: true type: boolean groupId: description: The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API. nullable: true readOnly: true type: integer isGraphQL: description: Whether the endpoint uses GraphQL to deliver structured content to clients. type: boolean lockVersion: description: The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. readOnly: true type: integer matchPathSegmentParam: default: true description: Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`. nullable: true type: boolean positiveConstrainsEnabled: description: Specifies whether the KSD firewall policies are enabled for the endpoint. nullable: true type: boolean productionStatus: description: The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED productionVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the production network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml protectedByApiKey: description: Whether you enabled API key protection for the endpoint version by making the version private. readOnly: true type: boolean responseConstraintsEnabled: description: Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled. nullable: true readOnly: true type: boolean securityScheme: additionalProperties: false description: Contains information about the key with which users may access the endpoint. nullable: true type: object properties: securitySchemeDetail: additionalProperties: false description: Contains information about the location of the API key. type: object properties: apiKeyLocation: description: The location of the API key in incoming requests, either `cookie`, `header`, or `query` parameter. type: string enum: - cookie - header - query apiKeyName: description: The name of the header, query parameter, or cookie where you located the API key. type: string securitySchemeType: description: The type of security scheme implemented for the endpoint. The only valid value is `apikey`. type: string enum: - apikey source: additionalProperties: false description: Contains information about the import file used to create the endpoint. nullable: true readOnly: true type: object properties: apiVersion: description: The major version of the API defined in the import file. nullable: true readOnly: true type: string specificationVersion: description: The version of the import file's specification. example: 3.0.0 nullable: true readOnly: true type: string type: description: The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`. nullable: true readOnly: true type: string enum: - SWAGGER - RAML x-akamai: file-path: schemas/apiEndpointSourceDto.yaml stagingStatus: description: The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the staging network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml updateDate: description: The ISO 6801 timestamp indicating when you last modified the endpoint. format: date-time nullable: true readOnly: true type: string updatedBy: description: The identifier for the user who last modified the endpoint. nullable: true readOnly: true type: string versionHidden: description: Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation. nullable: true readOnly: true type: boolean versionNumber: description: The endpoint version number. nullable: true type: integer x-akamai: file-path: schemas/apiEndpointWithResourceDto-recurse.yaml headers: Location: description: Relative URL for the cloned API endpoint. schema: type: string '400': description: Some of user input is invalid. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '403': description: You don't have access to the endpoint. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '404': description: The API endpoint is not found. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /endpoints/files: post: description: Imports an API definition file and creates a new endpoint based on the file contents. 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). operationId: post-endpoints-file summary: Register an endpoint from an API definition file tags: - Endpoints 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 requestBody: required: true content: application/json: example: contractId: C-0N7RAC71 groupId: 44681 importFileContent: ewogICJzd2FnZ2VyIjogIjIuMCIsCiAgImluZm8iOiB7CiAgICAidmVyc2lvbiI6ICIxLjAuMCIsCiAgICAidGl0bGUiOiAiQm9va3N0b3JlIEFQSSIsCiAgICAiZGVzY3JpcHRpb24iOiAiQW4gQVBJIGZvciBib29rc3RvcmUgdXNlcnMgYWxsb3dpbmcgdGhlbSB0byByZXRyaWV2ZSBib29rIGl0ZW1zLCBhZGQgbmV3IGl0ZW1zIChhZG1pbiB1c2VycyksIGFuZCBtb2RpZnkgZXhpc3RpbmcgaXRlbXMuIgogIH0sCiAgImhvc3QiOiAiYm9va3N0b3JlLmFwaS5ha2FtYWkuY29tIiwKICAic2NoZW1lcyI6IFsKICAgICJodHRwIiwKICAgICJodHRwcyIKICBdLAogICJzZWN1cml0eURlZmluaXRpb25zIjogewogICAgImFwaV9rZXkiOiB7CiAgICAgICJ0eXBlIjogImFwaUtleSIsCiAgICAgICJuYW1lIjogImFwaUtleSIsCiAgICAgICJpbiI6ICJoZWFkZXIiCiAgICB9CiAgfSwKICAiYmFzZVBhdGgiOiAiL2Jvb2tzdG9yZSIsCiAgInBhdGhzIjogewogICAgIi9ib29rcyI6IHsKICAgICAgImdldCI6IHsKICAgICAgICAiZGVzY3JpcHRpb24iOiAiTGlzdHMgYWxsIGJvb2sgaXRlbXMuIiwKICAgICAgICAib3BlcmF0aW9uSWQiOiAiZ2V0Qm9va3MiLAogICAgICAgICJwcm9kdWNlcyI6IFsKICAgICAgICAgICJhcHBsaWNhdGlvbi9qc29uIgogICAgICAgIF0sCiAgICAgICAgInJlc3BvbnNlcyI6IHsKICAgICAgICAgICIyMDAiOiB7CiAgICAgICAgICAgICJkZXNjcmlwdGlvbiI6ICJCb29rIHJlc3BvbnNlLiIsCiAgICAgICAgICAgICJzY2hlbWEiOiB7CiAgICAgICAgICAgICAgInR5cGUiOiAiYXJyYXkiLAogICAgICAgICAgICAgICJpdGVtcyI6IHsKICAgICAgICAgICAgICAgICIkcmVmIjogIiMvZGVmaW5pdGlvbnMvYm9vayIKICAgICAgICAgICAgICB9CiAgICAgICAgICAgIH0KICAgICAgICAgIH0KICAgICAgICB9CiAgICAgIH0sCiAgICAgICJwb3N0IjogewogICAgICAgICJkZXNjcmlwdGlvbiI6ICJDcmVhdGVzIGEgYm9vayBpdGVtIGluIHRoZSBib29rc3RvcmUuIiwKICAgICAgICAib3BlcmF0aW9uSWQiOiAicG9zdEJvb2siLAogICAgICAgICJwcm9kdWNlcyI6IFsKICAgICAgICAgICJhcHBsaWNhdGlvbi9qc29uIgogICAgICAgIF0sCiAgICAgICAgInBhcmFtZXRlcnMiOiBbewogICAgICAgICAgIm5hbWUiOiAiYm9vayIsCiAgICAgICAgICAiaW4iOiAiYm9keSIsCiAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiQSBib29rIHRvIGFkZCB0byB0aGUgYm9va3N0b3JlLiIsCiAgICAgICAgICAicmVxdWlyZWQiOiB0cnVlLAogICAgICAgICAgInNjaGVtYSI6IHsKICAgICAgICAgICAgIiRyZWYiOiAiIy9kZWZpbml0aW9ucy9uZXdCb29rIgogICAgICAgICAgfQogICAgICAgIH1dLAogICAgICAgICJyZXNwb25zZXMiOiB7CiAgICAgICAgICAiMjAwIjogewogICAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiQm9vayByZXNwb25zZS4iLAogICAgICAgICAgICAic2NoZW1hIjogewogICAgICAgICAgICAgICJ0eXBlIjogInN0cmluZyIsCiAgICAgICAgICAgICAgIiRyZWYiOiAiIy9kZWZpbml0aW9ucy9ib29rIgogICAgICAgICAgICB9CiAgICAgICAgICB9CiAgICAgICAgfQogICAgICB9CiAgICB9LAogICAgIi9ib29rcy97aWR9IjogewogICAgICAiZ2V0IjogewogICAgICAgICJkZXNjcmlwdGlvbiI6ICJSZXR1cm5zIGEgYm9vayBpdGVtLiIsCiAgICAgICAgIm9wZXJhdGlvbklkIjogImdldEJvb2siLAogICAgICAgICJwcm9kdWNlcyI6IFsKICAgICAgICAgICJhcHBsaWNhdGlvbi9qc29uIgogICAgICAgIF0sCiAgICAgICAgInBhcmFtZXRlcnMiOiBbewogICAgICAgICAgIm5hbWUiOiAiaWQiLAogICAgICAgICAgImluIjogInBhdGgiLAogICAgICAgICAgImRlc2NyaXB0aW9uIjogIkEgc3BlY2lmaWMgSUQgb2YgYSBib29rIGl0ZW0gdG8gcmV0dXJuLiIsCiAgICAgICAgICAicmVxdWlyZWQiOiB0cnVlLAogICAgICAgICAgInR5cGUiOiAiaW50ZWdlciIKICAgICAgICB9XSwKICAgICAgICAicmVzcG9uc2VzIjogewogICAgICAgICAgIjIwMCI6IHsKICAgICAgICAgICAgImRlc2NyaXB0aW9uIjogIkJvb2sgcmVzcG9uc2UuIiwKICAgICAgICAgICAgInNjaGVtYSI6IHsKICAgICAgICAgICAgICAidHlwZSI6ICJzdHJpbmciLAogICAgICAgICAgICAgICIkcmVmIjogIiMvZGVmaW5pdGlvbnMvYm9vayIKICAgICAgICAgICAgfQogICAgICAgICAgfQogICAgICAgIH0KICAgICAgfSwKICAgICAgImRlbGV0ZSI6IHsKICAgICAgICAiZGVzY3JpcHRpb24iOiAiRGVsZXRlcyBhIGJvb2sgaXRlbSBmcm9tIHRoZSBib29rc3RvcmUuIiwKICAgICAgICAib3BlcmF0aW9uSWQiOiAiZGVsZXRlQm9vayIsCiAgICAgICAgInByb2R1Y2VzIjogWwogICAgICAgICAgImFwcGxpY2F0aW9uL2pzb24iCiAgICAgICAgXSwKICAgICAgICAicGFyYW1ldGVycyI6IFt7CiAgICAgICAgICAibmFtZSI6ICJpZCIsCiAgICAgICAgICAiaW4iOiAicGF0aCIsCiAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiQSBzcGVjaWZpYyBJRCBvZiBhIGJvb2sgaXRlbSB0byBkZWxldGUuIiwKICAgICAgICAgICJyZXF1aXJlZCI6IHRydWUsCiAgICAgICAgICAidHlwZSI6ICJpbnRlZ2VyIgogICAgICAgIH1dLAogICAgICAgICJyZXNwb25zZXMiOiB7CiAgICAgICAgICAiMjA0IjogewogICAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiQm9vayBkZWxldGVkIgogICAgICAgICAgfQogICAgICAgIH0KICAgICAgfQogICAgfQogIH0KfQ== importFileFormat: swagger importFileSource: BODY_BASE64 schema: additionalProperties: false description: Contains information about an API definition file to import. type: object required: - importFileFormat - importFileSource properties: contractId: description: The unique identifier for the contract under which to provision the endpoint. example: '{{contractId}}' type: string groupId: description: The unique identifier for the group under which to provision the endpoint. example: '{{groupId}}' type: number importFileContent: description: The content of the API definition file encoded in Base64 (see [RFC 4648](https://tools.ietf.org/html/rfc4648) for details). Specify this only if you set the corresponding `importFileSource` to `BODY_BASE64`. example: '{{importFileContent}}' type: string importFileFormat: description: The format of the API definition file, either `raml` or `swagger`. You cam import RAML 0.8 files and Swagger 2.0 or 3.0 files. example: '{{importFileFormat}}' type: string enum: - swagger - raml importFileSource: description: The location of the API definition file, either `URL` if you store the file on the web, or `BODY_BASE64` if you encode the file contents in the request body. example: '{{importFileSource}}' type: string enum: - URL - BODY_BASE64 importUrl: description: The URL from which to get the API definition file. Specify this only if you set the corresponding `importFileSource` to `URL`. example: '{{importUrl}}' type: string root: description: If the import file located at the `importUrl` is a ZIP archive, this identifies the API definition's filename within the archive. example: '{{root}}' type: string x-akamai: file-path: schemas/importFileDto.yaml responses: '201': description: New resource successfully created. content: application/json: example: akamaiSecurityRestrictions: null apiEndPointId: 492375 apiEndPointLocked: false apiEndPointName: Bookstore API apiEndPointScheme: http/https apiGatewayEnabled: true basePath: /bookstore caseSensitive: true clonedFromVersion: 1 consumeType: any contractId: C-0N7RAC7 createDate: 2019-06-12T13:06:52+0000 createdBy: szhang description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. endpointHidden: false graphQL: false groupId: 44681 isGraphQL: false lockVersion: 2 positiveConstrainsEnabled: null productionStatus: null protectedByApiKey: true responseConstraintsEnabled: false source: null stagingStatus: null updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin versionHidden: false versionNumber: 1 apiCategoryIds: - 2 - 7 apiEndPointHosts: - bookstore.api.akamai.com availableActions: - DELETE - CLONE_ENDPOINT - ACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING productionVersion: lastError: null status: null timestamp: null versionNumber: null securityScheme: securitySchemeType: apikey securitySchemeDetail: apiKeyLocation: header apiKeyName: apikey stagingVersion: lastError: null status: null timestamp: null versionNumber: null apiResources: - apiResourceClonedFromId: null apiResourceId: 2926712 apiResourceLogicId: 118435 apiResourceName: books createDate: 2019-06-12T13:06:52+0000 createdBy: jperez description: A book item within the bookstore API. link: null lockVersion: 2 private: false resourcePath: /books/{bookId} updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin apiResourceMethods: - apiResourceMethod: GET apiResourceMethodId: 341591 apiResourceMethodLogicId: 184404 apiParameters: - apiParamLogicId: 578116 apiParameterId: 1212945 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string apiResourceMethParamId: 494448 array: false pathParamLocationId: null response: false apiChildParameters: [] - apiResourceMethod: POST apiResourceMethodId: 341592 apiResourceMethodLogicId: 184405 apiParameters: - apiParamLogicId: 578117 apiParameterId: 1212946 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterType: string apiResourceMethParamId: 494449 array: false pathParamLocationId: null response: false apiChildParameters: [] apiParameterRestriction: arrayRestriction: null numberRangeRestriction: null rangeRestriction: null xmlConversionRule: null lengthRestriction: lengthMax: 15 lengthMin: 3 schema: additionalProperties: false description: Contains information about an endpoint and its associated resources. type: object required: - apiEndPointName - apiEndPointHosts - groupId - contractId - lockVersion properties: akamaiSecurityRestrictions: additionalProperties: false description: Contains information about the Kona Site Defender security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a Kona Site Defender customer. nullable: true type: object properties: ALLOW_ONLY_SPEC_UNDEFINED_METHODS: description: Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_BODY_PARAMS: description: Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_COOKIE_PARAMS: description: Whether the API allows for requests with undefined parameters in cookies. These booleans override members in the Method object. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_HEADER_PARAMS: description: Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_DELETE: description: Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_GET: description: Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_HEAD: description: Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_OPTIONS: description: Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PATCH: description: Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_POST: description: Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PUT: description: Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_PARAMS: description: Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_QUERY_PARAMS: description: Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_RESOURCES: description: Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_SPEC_PARAMS: description: Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 MAX_BODY_SIZE: description: The maximum allowed size of a request body. nullable: true type: integer MAX_DOC_DEPTH: description: The maximum depth of nested data elements allowed in a request body. nullable: true type: integer MAX_ELEMENT_NAME_LENGTH: description: The maximum length of an XML element name or JSON object key name allowed in a request body. nullable: true type: integer MAX_INTEGER_VALUE: description: The maximum integer value allowed in a request body. nullable: true type: integer MAX_JSONXML_ELEMENT: description: The maximum number of XML elements, JSON object keys, or array items allowed in a request body. nullable: true type: integer MAX_STRING_LENGTH: description: The maximum length of any string value in a request body. nullable: true type: integer POSITIVE_SECURITY_ENABLED: description: Whether to enforce the API request body and resource constraints as allowlists in your KSD security policies. Either `1` for enabled security constraints, or `0` for disabled. type: integer enum: - 0 - 1 POSITIVE_SECURITY_VERSION: description: Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API. nullable: true type: integer enum: - 1 - 2 RESPONSE_RESTRICTIONS_ENABLED: description: When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`. type: integer enum: - 0 - 1 apiCategoryIds: description: The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints. nullable: true type: array items: type: integer apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint. minItems: 1 type: array items: type: string apiEndPointId: description: The unique identifier for the endpoint. nullable: true readOnly: true type: integer apiEndPointLocked: description: Whether the endpoint version is read-only. nullable: true readOnly: true type: boolean apiEndPointName: description: The name of the endpoint, unique within the account. type: string apiEndPointScheme: description: The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both. nullable: true type: string enum: - http - https - http/https apiEndPointVersion: description: The unique identifier for the endpoint version. nullable: true readOnly: true type: integer apiGatewayEnabled: default: true description: Whether the API Gateway product should be enabled for the endpoint. If `null`, the member is set to `true`. nullable: true type: boolean apiResources: description: The list of resources assigned to the endpoint. nullable: true type: array items: additionalProperties: false description: Contains information about a resource assigned to an endpoint. type: object required: - apiResourceName - resourcePath properties: apiResourceClonedFromId: description: For cloned resources, the unique identifier for the source resource. nullable: true type: integer apiResourceId: description: The unique identifier for the resource. type: integer apiResourceLogicId: description: The unique identifier for the resource across all endpoint versions. type: integer apiResourceMethodNameLists: description: The list of HTTP methods the resource may respond to. type: array items: type: string apiResourceMethods: description: The list of HTTP methods the resource may respond to. type: array items: additionalProperties: false description: Contains information about an HTTP method to which a resource may respond. type: object required: - apiResourceMethod properties: apiParameters: description: The list of parameter objects assigned to the method. nullable: true type: array items: additionalProperties: false description: Contains information about a method's parameter. type: object required: - apiParameterName - apiParameterType - apiParameterRequired - apiParameterLocation properties: apiChildParameters: description: The collection of child JSON members or XML elements for JSON or XML body type parameters. type: array items: description: A further nested endpoint object. type: object x-akamai: file-path: schemas/apiParameterDto-nested.yaml apiParamLogicId: description: The unique identifier for the parameter across all endpoint versions. readOnly: true type: integer apiParameterContentType: description: The content type of the parameter. Only applicable for top level body parameters. type: string enum: - json - xml - urlencoded - json/xml - any - none apiParameterId: description: The unique identifier for the parameter. readOnly: true type: integer apiParameterLocation: description: The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter. type: string enum: - query - body - header - path - cookie apiParameterName: description: The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`. type: string apiParameterNotes: description: The description to clarify the parameter's function. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`. nullable: true type: string apiParameterRequired: description: Specifies whether the API user needs to specify the parameter. If the corresponding `apiParameterLocation` is `path`, set this member to `true`. type: boolean apiParameterRestriction: additionalProperties: false description: Contains information about restrictions and XML representation rules specified for the parameter. nullable: true type: object properties: arrayRestriction: additionalProperties: false description: Contains information about array restrictions for array type parameters. Define this object only if you enabled the corresponding `array` member. nullable: true type: object properties: collectionFormat: default: csv description: The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance. type: string enum: - csv - ssv - tsv - pipes - multi maxItems: description: The maximum allowed number of array items. type: integer minItems: description: The minimum allowed number of array items. type: integer uniqueItems: description: Whether the array contains only unique items. type: boolean lengthRestriction: additionalProperties: false description: Contains information about length restrictions for string type parameters. nullable: true type: object properties: lengthMax: description: The maximum allowed number of characters in the string. nullable: true type: integer lengthMin: description: The minimum allowed number of characters in the string. nullable: true type: integer numberRangeRestriction: additionalProperties: false description: Contains information about range restrictions for number type parameters. nullable: true type: object properties: numberRangeMax: description: The maximum range restriction. nullable: true type: number numberRangeMin: description: The minimum range restriction. nullable: true type: number rangeRestriction: additionalProperties: false description: Contains information about range restrictions for integer type parameters. nullable: true type: object properties: rangeMax: description: The maximum range restriction. nullable: true type: integer rangeMin: description: The minimum range restriction. nullable: true type: integer responseRestriction: additionalProperties: false type: object properties: maxBodySize: description: Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size. type: string enum: - SIZE_6K - SIZE_8K - SIZE_12K - NO_LIMIT statusCodes: description: The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body. nullable: true type: array items: type: integer xmlConversionRule: additionalProperties: false description: Contains information about an XML representation of a JSON-encoded parameter. nullable: true type: object properties: attribute: default: false description: Whether the parameter should be represented as an attribute. type: boolean name: description: The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition. type: string namespace: description: The XML namespace. type: string prefix: description: The prefix for the XML namespace. type: string wrapped: default: false description: Whether the parameter should be wrapped in a parent XML element. type: boolean x-akamai: file-path: schemas/xmlRestrictionDto.yaml apiParameterType: description: The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects. type: string enum: - string - integer - number - boolean - json/xml apiResourceMethParamId: description: The unique identifier for the parameter's parent method. nullable: true readOnly: true type: integer array: description: Whether the parameter can express more than one value. This member is only applicable for `apiChildParameters` that you can specify if the corresponding `apiParameterLocation` is `body` and the `apiParameterType` is `json/xml`. If you enable this, also define the `arrayRestriction` member. type: boolean pathParamLocationId: description: The index of a segment that includes a path parameter in a resource path. For example, given a path `\books\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`. nullable: true type: number response: description: Whether the parameter is within a response type. type: boolean x-akamai: file-path: schemas/apiParameterDto.yaml apiResourceMethod: description: The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`. type: string enum: - GET - PUT - POST - DELETE - HEAD - PATCH - OPTIONS apiResourceMethodId: description: The unique identifier for the resource's allowed method. nullable: true readOnly: true type: integer apiResourceMethodLogicId: description: The unique identifier for the resource's method across all endpoint versions. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiMethodParametersDto.yaml apiResourceName: description: The name of the resource. type: string createDate: description: The ISO 6801 timestamp indicating when you created the resource. format: date-time type: string createdBy: description: The identifier for the user who created the resource. type: string description: description: The description to clarify the resource's function within the API. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. type: string link: description: The location of the navigable resource within this API, for use by API clients. nullable: true type: string lockVersion: description: The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. type: number private: description: Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key. type: boolean resourcePath: description: The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` member in the corresponding parameter definition matches the name that you specified in the resource path. type: string updateDate: description: The ISO 6801 timestamp indicating when you last modified the resource. format: date-time type: string updatedBy: description: The identifier for the user who last modified the resource. type: string x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml apiSource: description: Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`. nullable: true type: string enum: - USER - API_DISCOVERY apiVersionInfo: additionalProperties: false description: Contains information about a major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai. nullable: true type: object required: - location properties: location: description: The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter. type: string enum: - HEADER - BASE_PATH - QUERY parameterName: description: The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` member is either `HEADER` or `QUERY`. type: string value: description: The expected API version value in an incoming request. type: string x-akamai: file-path: schemas/apiVersionInfo.yaml availableActions: description: The collection of available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2). minItems: 0 nullable: true readOnly: true type: array items: type: string enum: - DELETE - CLONE_ENDPOINT - COMPARE_ENDPOINT - COMPARE_AAG_SETTINGS - COMPARE_RAPID_SETTINGS - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING - ACTIVATE_ON_PRODUCTION - DEACTIVATE_ON_STAGING - DEACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - SHOW_ENDPOINT basePath: description: The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. minLength: 0 nullable: true type: string caseSensitive: description: Whether the URLs and parameters within the endpoint are case sensitive. nullable: true type: boolean clonedFromVersion: description: For cloned endpoints, the unique identifier for the source endpoint version. nullable: true readOnly: true type: integer consumeType: description: The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string. nullable: true type: string enum: - none - json - xml - json/xml - any - urlencoded - json/urlencoded - xml/urlencoded - json/xml/urlencoded contractId: description: The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API. nullable: true readOnly: true type: string createDate: description: The ISO 6801 timestamp indicating when you created the endpoint. format: date-time nullable: true readOnly: true type: string createdBy: description: The identifier for the user who created the endpoint. nullable: true readOnly: true type: string description: description: The description of the endpoint. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. nullable: true type: string discoveredPiiIds: description: The collection of personally identifiable information (PII) in your API parameters discovered by the network. nullable: true type: array items: type: integer endpointHidden: description: Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation. nullable: true readOnly: true type: boolean groupId: description: The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API. nullable: true readOnly: true type: integer isGraphQL: description: Whether the endpoint uses GraphQL to deliver structured content to clients. type: boolean lockVersion: description: The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. readOnly: true type: integer matchPathSegmentParam: default: true description: Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`. nullable: true type: boolean positiveConstrainsEnabled: description: Specifies whether the KSD firewall policies are enabled for the endpoint. nullable: true type: boolean productionStatus: description: The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED productionVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the production network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml protectedByApiKey: description: Whether you enabled API key protection for the endpoint version by making the version private. readOnly: true type: boolean responseConstraintsEnabled: description: Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled. nullable: true readOnly: true type: boolean securityScheme: additionalProperties: false description: Contains information about the key with which users may access the endpoint. nullable: true type: object properties: securitySchemeDetail: additionalProperties: false description: Contains information about the location of the API key. type: object properties: apiKeyLocation: description: The location of the API key in incoming requests, either `cookie`, `header`, or `query` parameter. type: string enum: - cookie - header - query apiKeyName: description: The name of the header, query parameter, or cookie where you located the API key. type: string securitySchemeType: description: The type of security scheme implemented for the endpoint. The only valid value is `apikey`. type: string enum: - apikey source: additionalProperties: false description: Contains information about the import file used to create the endpoint. nullable: true readOnly: true type: object properties: apiVersion: description: The major version of the API defined in the import file. nullable: true readOnly: true type: string specificationVersion: description: The version of the import file's specification. example: 3.0.0 nullable: true readOnly: true type: string type: description: The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`. nullable: true readOnly: true type: string enum: - SWAGGER - RAML x-akamai: file-path: schemas/apiEndpointSourceDto.yaml stagingStatus: description: The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the staging network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml updateDate: description: The ISO 6801 timestamp indicating when you last modified the endpoint. format: date-time nullable: true readOnly: true type: string updatedBy: description: The identifier for the user who last modified the endpoint. nullable: true readOnly: true type: string versionHidden: description: Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation. nullable: true readOnly: true type: boolean versionNumber: description: The endpoint version number. nullable: true type: integer x-akamai: file-path: schemas/apiEndpointWithResourceDto-recurse.yaml headers: Location: description: Relative URL for the newly created API endpoint. schema: type: string '400': description: Some of the file input data is invalid. content: application/json: example: apiEndpointDetails: akamaiSecurityRestrictions: null apiCategoryIds: null apiEndPointId: null apiEndPointLocked: null apiEndPointName: Bookstore API apiEndPointScheme: http/https apiProtectVersion: null basePath: /bookstore clonedFromVersion: null consumeType: any contractId: null createDate: null createdBy: null description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. groupId: null lockVersion: -1 productionStatus: null productionVersion: null protectedByApiKey: false securityScheme: null stagingStatus: null stagingVersion: null updateDate: null updatedBy: null versionNumber: null apiEndPointHosts: - bookstore.api.akamai.com apiResources: [] problems: - detail: 'The object instance has properties which are not allowed by the schema: ["unrecognizable"]' domain: validation keyword: additionalProperties level: error pointer: /paths/books/post title: Invalid schema type: /api-definitions/error-types/IMPORT-INVALID-SCHEMA schema: additionalProperties: false description: Contains information about a result of an import operation, including endpoint details and a list of potential issues. type: object properties: apiEndpointDetails: additionalProperties: false description: Contains information about the imported endpoint. type: object required: - apiEndPointName - apiEndPointHosts - groupId - contractId - lockVersion properties: akamaiSecurityRestrictions: additionalProperties: false description: Contains information about the Kona Site Defender security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a Kona Site Defender customer. nullable: true type: object properties: ALLOW_ONLY_SPEC_UNDEFINED_METHODS: description: Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_BODY_PARAMS: description: Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_COOKIE_PARAMS: description: Whether the API allows for requests with undefined parameters in cookies. These booleans override members in the Method object. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_HEADER_PARAMS: description: Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_DELETE: description: Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_GET: description: Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_HEAD: description: Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_OPTIONS: description: Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PATCH: description: Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_POST: description: Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PUT: description: Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_PARAMS: description: Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_QUERY_PARAMS: description: Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_RESOURCES: description: Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_SPEC_PARAMS: description: Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 MAX_BODY_SIZE: description: The maximum allowed size of a request body. nullable: true type: integer MAX_DOC_DEPTH: description: The maximum depth of nested data elements allowed in a request body. nullable: true type: integer MAX_ELEMENT_NAME_LENGTH: description: The maximum length of an XML element name or JSON object key name allowed in a request body. nullable: true type: integer MAX_INTEGER_VALUE: description: The maximum integer value allowed in a request body. nullable: true type: integer MAX_JSONXML_ELEMENT: description: The maximum number of XML elements, JSON object keys, or array items allowed in a request body. nullable: true type: integer MAX_STRING_LENGTH: description: The maximum length of any string value in a request body. nullable: true type: integer POSITIVE_SECURITY_ENABLED: description: Whether to enforce the API request body and resource constraints as allowlists in your KSD security policies. Either `1` for enabled security constraints, or `0` for disabled. type: integer enum: - 0 - 1 POSITIVE_SECURITY_VERSION: description: Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API. nullable: true type: integer enum: - 1 - 2 RESPONSE_RESTRICTIONS_ENABLED: description: When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`. type: integer enum: - 0 - 1 apiCategoryIds: description: The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints. nullable: true type: array items: type: integer apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint. minItems: 1 type: array items: type: string apiEndPointId: description: The unique identifier for the endpoint. nullable: true readOnly: true type: integer apiEndPointLocked: description: Whether the endpoint version is read-only. nullable: true readOnly: true type: boolean apiEndPointName: description: The name of the endpoint, unique within the account. type: string apiEndPointScheme: description: The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both. nullable: true type: string enum: - http - https - http/https apiEndPointVersion: description: The unique identifier for the endpoint version. nullable: true readOnly: true type: integer apiGatewayEnabled: default: true description: Whether the API Gateway product should be enabled for the endpoint. If `null`, the member is set to `true`. nullable: true type: boolean apiResources: description: The list of resources assigned to the endpoint. nullable: true type: array items: additionalProperties: false description: Contains information about a resource assigned to an endpoint. type: object required: - apiResourceName - resourcePath properties: apiResourceClonedFromId: description: For cloned resources, the unique identifier for the source resource. nullable: true type: integer apiResourceId: description: The unique identifier for the resource. type: integer apiResourceLogicId: description: The unique identifier for the resource across all endpoint versions. type: integer apiResourceMethodNameLists: description: The list of HTTP methods the resource may respond to. type: array items: type: string apiResourceMethods: description: The list of HTTP methods the resource may respond to. type: array items: additionalProperties: false description: Contains information about an HTTP method to which a resource may respond. type: object required: - apiResourceMethod properties: apiParameters: description: The list of parameter objects assigned to the method. nullable: true type: array items: additionalProperties: false description: Contains information about a method's parameter. type: object required: - apiParameterName - apiParameterType - apiParameterRequired - apiParameterLocation properties: apiChildParameters: description: The collection of child JSON members or XML elements for JSON or XML body type parameters. type: array items: description: A further nested endpoint object. type: object x-akamai: file-path: schemas/apiParameterDto-nested.yaml apiParamLogicId: description: The unique identifier for the parameter across all endpoint versions. readOnly: true type: integer apiParameterContentType: description: The content type of the parameter. Only applicable for top level body parameters. type: string enum: - json - xml - urlencoded - json/xml - any - none apiParameterId: description: The unique identifier for the parameter. readOnly: true type: integer apiParameterLocation: description: The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter. type: string enum: - query - body - header - path - cookie apiParameterName: description: The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`. type: string apiParameterNotes: description: The description to clarify the parameter's function. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`. nullable: true type: string apiParameterRequired: description: Specifies whether the API user needs to specify the parameter. If the corresponding `apiParameterLocation` is `path`, set this member to `true`. type: boolean apiParameterRestriction: additionalProperties: false description: Contains information about restrictions and XML representation rules specified for the parameter. nullable: true type: object properties: arrayRestriction: additionalProperties: false description: Contains information about array restrictions for array type parameters. Define this object only if you enabled the corresponding `array` member. nullable: true type: object properties: collectionFormat: default: csv description: The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance. type: string enum: - csv - ssv - tsv - pipes - multi maxItems: description: The maximum allowed number of array items. type: integer minItems: description: The minimum allowed number of array items. type: integer uniqueItems: description: Whether the array contains only unique items. type: boolean lengthRestriction: additionalProperties: false description: Contains information about length restrictions for string type parameters. nullable: true type: object properties: lengthMax: description: The maximum allowed number of characters in the string. nullable: true type: integer lengthMin: description: The minimum allowed number of characters in the string. nullable: true type: integer numberRangeRestriction: additionalProperties: false description: Contains information about range restrictions for number type parameters. nullable: true type: object properties: numberRangeMax: description: The maximum range restriction. nullable: true type: number numberRangeMin: description: The minimum range restriction. nullable: true type: number rangeRestriction: additionalProperties: false description: Contains information about range restrictions for integer type parameters. nullable: true type: object properties: rangeMax: description: The maximum range restriction. nullable: true type: integer rangeMin: description: The minimum range restriction. nullable: true type: integer responseRestriction: additionalProperties: false type: object properties: maxBodySize: description: Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size. type: string enum: - SIZE_6K - SIZE_8K - SIZE_12K - NO_LIMIT statusCodes: description: The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body. nullable: true type: array items: type: integer xmlConversionRule: additionalProperties: false description: Contains information about an XML representation of a JSON-encoded parameter. nullable: true type: object properties: attribute: default: false description: Whether the parameter should be represented as an attribute. type: boolean name: description: The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition. type: string namespace: description: The XML namespace. type: string prefix: description: The prefix for the XML namespace. type: string wrapped: default: false description: Whether the parameter should be wrapped in a parent XML element. type: boolean x-akamai: file-path: schemas/xmlRestrictionDto.yaml apiParameterType: description: The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects. type: string enum: - string - integer - number - boolean - json/xml apiResourceMethParamId: description: The unique identifier for the parameter's parent method. nullable: true readOnly: true type: integer array: description: Whether the parameter can express more than one value. This member is only applicable for `apiChildParameters` that you can specify if the corresponding `apiParameterLocation` is `body` and the `apiParameterType` is `json/xml`. If you enable this, also define the `arrayRestriction` member. type: boolean pathParamLocationId: description: The index of a segment that includes a path parameter in a resource path. For example, given a path `\books\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`. nullable: true type: number response: description: Whether the parameter is within a response type. type: boolean x-akamai: file-path: schemas/apiParameterDto.yaml apiResourceMethod: description: The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`. type: string enum: - GET - PUT - POST - DELETE - HEAD - PATCH - OPTIONS apiResourceMethodId: description: The unique identifier for the resource's allowed method. nullable: true readOnly: true type: integer apiResourceMethodLogicId: description: The unique identifier for the resource's method across all endpoint versions. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiMethodParametersDto.yaml apiResourceName: description: The name of the resource. type: string createDate: description: The ISO 6801 timestamp indicating when you created the resource. format: date-time type: string createdBy: description: The identifier for the user who created the resource. type: string description: description: The description to clarify the resource's function within the API. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. type: string link: description: The location of the navigable resource within this API, for use by API clients. nullable: true type: string lockVersion: description: The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. type: number private: description: Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key. type: boolean resourcePath: description: The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` member in the corresponding parameter definition matches the name that you specified in the resource path. type: string updateDate: description: The ISO 6801 timestamp indicating when you last modified the resource. format: date-time type: string updatedBy: description: The identifier for the user who last modified the resource. type: string x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml apiSource: description: Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`. nullable: true type: string enum: - USER - API_DISCOVERY apiVersionInfo: additionalProperties: false description: Contains information about a major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai. nullable: true type: object required: - location properties: location: description: The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter. type: string enum: - HEADER - BASE_PATH - QUERY parameterName: description: The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` member is either `HEADER` or `QUERY`. type: string value: description: The expected API version value in an incoming request. type: string x-akamai: file-path: schemas/apiVersionInfo.yaml availableActions: description: The collection of available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2). minItems: 0 nullable: true readOnly: true type: array items: type: string enum: - DELETE - CLONE_ENDPOINT - COMPARE_ENDPOINT - COMPARE_AAG_SETTINGS - COMPARE_RAPID_SETTINGS - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING - ACTIVATE_ON_PRODUCTION - DEACTIVATE_ON_STAGING - DEACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - SHOW_ENDPOINT basePath: description: The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. minLength: 0 nullable: true type: string caseSensitive: description: Whether the URLs and parameters within the endpoint are case sensitive. nullable: true type: boolean clonedFromVersion: description: For cloned endpoints, the unique identifier for the source endpoint version. nullable: true readOnly: true type: integer consumeType: description: The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string. nullable: true type: string enum: - none - json - xml - json/xml - any - urlencoded - json/urlencoded - xml/urlencoded - json/xml/urlencoded contractId: description: The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API. nullable: true readOnly: true type: string createDate: description: The ISO 6801 timestamp indicating when you created the endpoint. format: date-time nullable: true readOnly: true type: string createdBy: description: The identifier for the user who created the endpoint. nullable: true readOnly: true type: string description: description: The description of the endpoint. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. nullable: true type: string discoveredPiiIds: description: The collection of personally identifiable information (PII) in your API parameters discovered by the network. nullable: true type: array items: type: integer endpointHidden: description: Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation. nullable: true readOnly: true type: boolean groupId: description: The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API. nullable: true readOnly: true type: integer isGraphQL: description: Whether the endpoint uses GraphQL to deliver structured content to clients. type: boolean lockVersion: description: The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. readOnly: true type: integer matchPathSegmentParam: default: true description: Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`. nullable: true type: boolean positiveConstrainsEnabled: description: Specifies whether the KSD firewall policies are enabled for the endpoint. nullable: true type: boolean productionStatus: description: The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED productionVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the production network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml protectedByApiKey: description: Whether you enabled API key protection for the endpoint version by making the version private. readOnly: true type: boolean responseConstraintsEnabled: description: Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled. nullable: true readOnly: true type: boolean securityScheme: additionalProperties: false description: Contains information about the key with which users may access the endpoint. nullable: true type: object properties: securitySchemeDetail: additionalProperties: false description: Contains information about the location of the API key. type: object properties: apiKeyLocation: description: The location of the API key in incoming requests, either `cookie`, `header`, or `query` parameter. type: string enum: - cookie - header - query apiKeyName: description: The name of the header, query parameter, or cookie where you located the API key. type: string securitySchemeType: description: The type of security scheme implemented for the endpoint. The only valid value is `apikey`. type: string enum: - apikey source: additionalProperties: false description: Contains information about the import file used to create the endpoint. nullable: true readOnly: true type: object properties: apiVersion: description: The major version of the API defined in the import file. nullable: true readOnly: true type: string specificationVersion: description: The version of the import file's specification. example: 3.0.0 nullable: true readOnly: true type: string type: description: The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`. nullable: true readOnly: true type: string enum: - SWAGGER - RAML x-akamai: file-path: schemas/apiEndpointSourceDto.yaml stagingStatus: description: The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the staging network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml updateDate: description: The ISO 6801 timestamp indicating when you last modified the endpoint. format: date-time nullable: true readOnly: true type: string updatedBy: description: The identifier for the user who last modified the endpoint. nullable: true readOnly: true type: string versionHidden: description: Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation. nullable: true readOnly: true type: boolean versionNumber: description: The endpoint version number. nullable: true type: integer x-akamai: file-path: schemas/apiEndpointWithResourceDto-recurse.yaml problems: description: The list of problems that occurred during the import, such as schema errors or unsupported property warnings. type: array items: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml x-akamai: file-path: schemas/importResult.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /endpoints/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 Kona Site Defender 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 Kona Site Defender customers, and the `API_PURPOSE` permission is for Bot Manager customers. operationId: get-user-entitlements summary: List user entitlements tags: - Endpoints 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 responses: '200': description: Set of entitlements. content: application/json: example: - API_READ - API_WRITE - API_VERSIONING - API_FEATURES schema: description: The collection of 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 KSD features, `AAG_FEATURES` for access to delivery settings, or `API_PURPOSE` for access to resource purpose settings. type: array items: type: string enum: - API_READ - API_WRITE - API_VERSIONING - API_FEATURES - AAG_FEATURES - API_PURPOSE x-akamai: file-path: schemas/userEntitlementsDto.yaml '403': description: You don't have access to the endpoint. content: application/problem+json: example: detail: You don't have access to the endpoint. instance: https://problems.luna.akamaiapis.net/api-defintions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 status: 403 title: Unauthorized Access/Action type: https://problems.luna.akamaiapis.net/api-defintions/error-types/UNAUTHORIZED schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /endpoints/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. operationId: post-endpoints-verify-secure-connection summary: Verify secure connection tags: - Endpoints 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 requestBody: required: true content: application/json: example: hosts: - bookstore.api.akamai.com - bookstore2.api.akamai.com:8443 - bookstore-premium.api.akamai.com certChain: content: '-----BEGIN CERTIFICATE----- MIIFsDCCA5igAwIBAgIJAL7HIonYis0aMA0GCSqGSIb3DQEBCwUAMG0xCzAJBgNV BAYTAlVTMREwDwYDVQQIDAhyYXBpZHppazERMA8GA1UEBwwIcmFwaWR6aWsxETAP BgNVBAoMCHJhcGlkemlrMREwDwYDVQQLDAhyYXBpZHppazESMBAGA1UEAwwJbG9j YWxob3N0MB4XDTE5MDYxMTE0MzI0NloXDTI0MDYwOTE0MzI0NlowbTELMAkGA1UE BhMCVVMxETAPBgNVBAgMCHJhcGlkemlrMREwDwYDVQQHDAhyYXBpZHppazERMA8G A1UECgwIcmFwaWR6aWsxETAPBgNVBAsMCHJhcGlkemlrMRIwEAYDVQQDDAlsb2Nh bGhvc3QwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCua7kn9yrkpMMH T18yzPFK9LBPk4GzMX0BZfEi2jzKKoc00BtoU/zeS9ewj+2IdIoHa19GE7qnnMux kbwm6GNkFt4rzJsQ5ruMSKEqzd4I81HDmS5s2X3o4ZqYWVHAx/rqsh5EIt5qAjq4 jebXeMuhlnkx6jMs+4+ZFfATVvOJ78VnUGUheNTcTGgCvxU7ZZ3+IZubJ6BVdJjC wxM30eroVF3efX4HrRXhLtatQtxjX6g2qOUfFiuNNLcgx+4NPqbKpecqyUbopt18 72MmohKy+YfVEk7OFWLyNPoL237KCznkCGwcQYrXTJzDVAN4NqQEo513nIHEC89F X/WomZWwLKVyQpiA1z/jUdYnSzsrPSuA+oP1WmfwVjtxeiwB7Asy/d/5OmOtID+a zT41irl1Dp5F6mgAI8CZ1LnzYIlvJAQS9+cpLG9rsyYDRr5+78TebiqP02CrRj9S stoam6WG21Z9fJ/aPKJ0ZQHkpXuHDy6RHJro+2wk0coWOyNT0UH6/7kuKHjEGaAG BXjElxZ8pJySwYXeeD5gmimQKPE/us1BD2jk0KWYxnwJ+jM4S7RipgTSGsy3Nw42 vKnKw6FwOIoQqwTkiNF+p7EsjeciO09zLecXxlh3p8WREEZU5NICmGL7xItdD+7I Vr/tn3XNbuSUu0IqdbhO19JoNXG/UwIDAQABo1MwUTAdBgNVHQ4EFgQUcXwqRZUC j9+VsyCfy4oIMN9u1V0wHwYDVR0jBBgwFoAUcXwqRZUCj9+VsyCfy4oIMN9u1V0w DwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAgEAQgWlrEW+K3fCMO9K 2TuxY6ruXbdekRv+nw+weXe9+GLlyvEFxktYTE/cN8pHrKOG6F/ea+CCHW4xenVp pchFI8zPQ8kDEDUUrPaQLbw9kzXKLZwUs+KMZXEZJInxWrr1mWeP+lVSf6f4hwNd fvJ8SOPe3/IAE0C79JaclzYE3ErfTlBeouQ09jXbeHc0VvodFp7XcmIMA9e5zIzu CU1QOa1LRrn5+TI41BbjKypMl8EE7ZEoyWRj4sMQGfuh9/kmu9ZPINJ79/j22vZG Vj72jKoIu01qI0esfL7GcE9gd9eWhDRuBYNCAfXWK7xvMwYIxeLgP9LJoeBCVMV+ 7k1AHGpgU4UYveu71VCUIlGIaL1t/DKHi8SqDaKV2eImurPp90eLWAU1V6b+UG5/ +HoUI8Kd5KgfPprv4AKKOTse04xbFDehvgCpQpcwzoV0h2AQtHhsN65dXfO3XPnR YQka7OQcEJS/gLXl7FIcpfkNyvi8ompHVSGTnAEB4qAwazz3FWe6r7qbqty2n0Ye NTkylMbBMFpMZrP4BP6YFf3BnkzjFcffHvtVGGUbyebQazc+5HyZycabEhekETeS LUOCwFWH68wXI23eU5Z7mKAI+rwhqVuJZPzZFUWfNhj7Pt/aby+7SIZAQ9YCR2lk 6IUdRIpisR9k478g/4pQYly6yN4= -----END CERTIFICATE-----' name: bookstore_cert.pem schema: additionalProperties: false description: Contains the hostnames and certificate chain for secure connection verification. type: object required: - hosts - certChain properties: certChain: additionalProperties: false description: Contains information about a PEM file with the certificate to use for verification of hostnames included in the corresponding `hosts` member. type: object 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 hosts: description: The list of HTTPS hostnames to verify. Each hostname must 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. type: array items: type: string x-akamai: file-path: schemas/verifySecureConnectionDto.yaml responses: '200': description: The map of hostnames to verification statuses. 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: Contains information about each hostname to verify and its corresponding connection status. type: object x-akamai: file-path: schemas/verifySecureConnectionDto-response.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /endpoints/{apiEndPointId}: parameters: - description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' in: path name: apiEndPointId required: true schema: example: 1 type: integer x-akamai: file-path: parameters/apiEndPointId-path.yaml 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. operationId: delete-endpoint summary: Delete an endpoint tags: - Endpoints externalDocs: description: See documentation for this operation in Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference/delete-endpoint responses: '204': description: Resource successfully deleted. content: '*/*': {} '403': description: You don't have access to the endpoint. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '404': description: The API endpoint is not found. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /endpoints/{apiEndPointId}/hide: parameters: - description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' in: path name: apiEndPointId required: true schema: example: 1 type: integer x-akamai: file-path: parameters/apiEndPointId-path.yaml 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. operationId: post-endpoint-hide summary: Hide an endpoint tags: - Endpoints 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 responses: '200': description: Operation succeeded. content: application/json: example: akamaiSecurityRestrictions: null apiEndPointId: 492375 apiEndPointLocked: false apiEndPointName: Bookstore API apiEndPointScheme: http/https apiGatewayEnabled: true basePath: /bookstore caseSensitive: true clonedFromVersion: 1 consumeType: any contractId: K-0N7RAK71 createDate: 2019-06-12T13:06:52+0000 createdBy: jsmith description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. endpointHidden: false graphQL: false groupId: 44681 isGraphQL: false lockVersion: 2 positiveConstrainsEnabled: null productionStatus: null protectedByApiKey: true responseConstraintsEnabled: false source: null stagingStatus: null updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin versionHidden: false versionNumber: 1 apiCategoryIds: - 2 - 7 apiEndPointHosts: - bookstore.api.akamai.com availableActions: - DELETE - CLONE_ENDPOINT - ACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING productionVersion: lastError: null status: null timestamp: null versionNumber: null securityScheme: securitySchemeType: apikey securitySchemeDetail: apiKeyLocation: header apiKeyName: apikey stagingVersion: lastError: null status: null timestamp: null versionNumber: null apiResources: - apiResourceClonedFromId: null apiResourceId: 2926712 apiResourceLogicId: 118435 apiResourceName: books createDate: 2019-06-12T13:06:52+0000 createdBy: szhang description: A book item within the bookstore API. link: null lockVersion: 2 private: false resourcePath: /books/{bookId} updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin apiResourceMethods: - apiResourceMethod: GET apiResourceMethodId: 341591 apiResourceMethodLogicId: 184404 apiParameters: - apiParamLogicId: 578116 apiParameterId: 1212945 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string apiResourceMethParamId: 494448 array: false pathParamLocationId: null response: false apiChildParameters: [] - apiResourceMethod: POST apiResourceMethodId: 341592 apiResourceMethodLogicId: 184405 apiParameters: - apiParamLogicId: 578117 apiParameterId: 1212946 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterType: string apiResourceMethParamId: 494449 array: false pathParamLocationId: null response: false apiChildParameters: [] apiParameterRestriction: arrayRestriction: null numberRangeRestriction: null rangeRestriction: null xmlConversionRule: null lengthRestriction: lengthMax: 15 lengthMin: 3 schema: additionalProperties: false description: Contains information about an endpoint and its associated resources. type: object required: - apiEndPointName - apiEndPointHosts - groupId - contractId - lockVersion properties: akamaiSecurityRestrictions: additionalProperties: false description: Contains information about the Kona Site Defender security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a Kona Site Defender customer. nullable: true type: object properties: ALLOW_ONLY_SPEC_UNDEFINED_METHODS: description: Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_BODY_PARAMS: description: Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_COOKIE_PARAMS: description: Whether the API allows for requests with undefined parameters in cookies. These booleans override members in the Method object. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_HEADER_PARAMS: description: Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_DELETE: description: Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_GET: description: Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_HEAD: description: Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_OPTIONS: description: Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PATCH: description: Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_POST: description: Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PUT: description: Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_PARAMS: description: Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_QUERY_PARAMS: description: Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_RESOURCES: description: Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_SPEC_PARAMS: description: Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 MAX_BODY_SIZE: description: The maximum allowed size of a request body. nullable: true type: integer MAX_DOC_DEPTH: description: The maximum depth of nested data elements allowed in a request body. nullable: true type: integer MAX_ELEMENT_NAME_LENGTH: description: The maximum length of an XML element name or JSON object key name allowed in a request body. nullable: true type: integer MAX_INTEGER_VALUE: description: The maximum integer value allowed in a request body. nullable: true type: integer MAX_JSONXML_ELEMENT: description: The maximum number of XML elements, JSON object keys, or array items allowed in a request body. nullable: true type: integer MAX_STRING_LENGTH: description: The maximum length of any string value in a request body. nullable: true type: integer POSITIVE_SECURITY_ENABLED: description: Whether to enforce the API request body and resource constraints as allowlists in your KSD security policies. Either `1` for enabled security constraints, or `0` for disabled. type: integer enum: - 0 - 1 POSITIVE_SECURITY_VERSION: description: Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API. nullable: true type: integer enum: - 1 - 2 RESPONSE_RESTRICTIONS_ENABLED: description: When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`. type: integer enum: - 0 - 1 apiCategoryIds: description: The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints. nullable: true type: array items: type: integer apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint. minItems: 1 type: array items: type: string apiEndPointId: description: The unique identifier for the endpoint. nullable: true readOnly: true type: integer apiEndPointLocked: description: Whether the endpoint version is read-only. nullable: true readOnly: true type: boolean apiEndPointName: description: The name of the endpoint, unique within the account. type: string apiEndPointScheme: description: The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both. nullable: true type: string enum: - http - https - http/https apiEndPointVersion: description: The unique identifier for the endpoint version. nullable: true readOnly: true type: integer apiGatewayEnabled: default: true description: Whether the API Gateway product should be enabled for the endpoint. If `null`, the member is set to `true`. nullable: true type: boolean apiResources: description: The list of resources assigned to the endpoint. nullable: true type: array items: additionalProperties: false description: Contains information about a resource assigned to an endpoint. type: object required: - apiResourceName - resourcePath properties: apiResourceClonedFromId: description: For cloned resources, the unique identifier for the source resource. nullable: true type: integer apiResourceId: description: The unique identifier for the resource. type: integer apiResourceLogicId: description: The unique identifier for the resource across all endpoint versions. type: integer apiResourceMethodNameLists: description: The list of HTTP methods the resource may respond to. type: array items: type: string apiResourceMethods: description: The list of HTTP methods the resource may respond to. type: array items: additionalProperties: false description: Contains information about an HTTP method to which a resource may respond. type: object required: - apiResourceMethod properties: apiParameters: description: The list of parameter objects assigned to the method. nullable: true type: array items: additionalProperties: false description: Contains information about a method's parameter. type: object required: - apiParameterName - apiParameterType - apiParameterRequired - apiParameterLocation properties: apiChildParameters: description: The collection of child JSON members or XML elements for JSON or XML body type parameters. type: array items: description: A further nested endpoint object. type: object x-akamai: file-path: schemas/apiParameterDto-nested.yaml apiParamLogicId: description: The unique identifier for the parameter across all endpoint versions. readOnly: true type: integer apiParameterContentType: description: The content type of the parameter. Only applicable for top level body parameters. type: string enum: - json - xml - urlencoded - json/xml - any - none apiParameterId: description: The unique identifier for the parameter. readOnly: true type: integer apiParameterLocation: description: The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter. type: string enum: - query - body - header - path - cookie apiParameterName: description: The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`. type: string apiParameterNotes: description: The description to clarify the parameter's function. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`. nullable: true type: string apiParameterRequired: description: Specifies whether the API user needs to specify the parameter. If the corresponding `apiParameterLocation` is `path`, set this member to `true`. type: boolean apiParameterRestriction: additionalProperties: false description: Contains information about restrictions and XML representation rules specified for the parameter. nullable: true type: object properties: arrayRestriction: additionalProperties: false description: Contains information about array restrictions for array type parameters. Define this object only if you enabled the corresponding `array` member. nullable: true type: object properties: collectionFormat: default: csv description: The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance. type: string enum: - csv - ssv - tsv - pipes - multi maxItems: description: The maximum allowed number of array items. type: integer minItems: description: The minimum allowed number of array items. type: integer uniqueItems: description: Whether the array contains only unique items. type: boolean lengthRestriction: additionalProperties: false description: Contains information about length restrictions for string type parameters. nullable: true type: object properties: lengthMax: description: The maximum allowed number of characters in the string. nullable: true type: integer lengthMin: description: The minimum allowed number of characters in the string. nullable: true type: integer numberRangeRestriction: additionalProperties: false description: Contains information about range restrictions for number type parameters. nullable: true type: object properties: numberRangeMax: description: The maximum range restriction. nullable: true type: number numberRangeMin: description: The minimum range restriction. nullable: true type: number rangeRestriction: additionalProperties: false description: Contains information about range restrictions for integer type parameters. nullable: true type: object properties: rangeMax: description: The maximum range restriction. nullable: true type: integer rangeMin: description: The minimum range restriction. nullable: true type: integer responseRestriction: additionalProperties: false type: object properties: maxBodySize: description: Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size. type: string enum: - SIZE_6K - SIZE_8K - SIZE_12K - NO_LIMIT statusCodes: description: The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body. nullable: true type: array items: type: integer xmlConversionRule: additionalProperties: false description: Contains information about an XML representation of a JSON-encoded parameter. nullable: true type: object properties: attribute: default: false description: Whether the parameter should be represented as an attribute. type: boolean name: description: The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition. type: string namespace: description: The XML namespace. type: string prefix: description: The prefix for the XML namespace. type: string wrapped: default: false description: Whether the parameter should be wrapped in a parent XML element. type: boolean x-akamai: file-path: schemas/xmlRestrictionDto.yaml apiParameterType: description: The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects. type: string enum: - string - integer - number - boolean - json/xml apiResourceMethParamId: description: The unique identifier for the parameter's parent method. nullable: true readOnly: true type: integer array: description: Whether the parameter can express more than one value. This member is only applicable for `apiChildParameters` that you can specify if the corresponding `apiParameterLocation` is `body` and the `apiParameterType` is `json/xml`. If you enable this, also define the `arrayRestriction` member. type: boolean pathParamLocationId: description: The index of a segment that includes a path parameter in a resource path. For example, given a path `\books\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`. nullable: true type: number response: description: Whether the parameter is within a response type. type: boolean x-akamai: file-path: schemas/apiParameterDto.yaml apiResourceMethod: description: The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`. type: string enum: - GET - PUT - POST - DELETE - HEAD - PATCH - OPTIONS apiResourceMethodId: description: The unique identifier for the resource's allowed method. nullable: true readOnly: true type: integer apiResourceMethodLogicId: description: The unique identifier for the resource's method across all endpoint versions. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiMethodParametersDto.yaml apiResourceName: description: The name of the resource. type: string createDate: description: The ISO 6801 timestamp indicating when you created the resource. format: date-time type: string createdBy: description: The identifier for the user who created the resource. type: string description: description: The description to clarify the resource's function within the API. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. type: string link: description: The location of the navigable resource within this API, for use by API clients. nullable: true type: string lockVersion: description: The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. type: number private: description: Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key. type: boolean resourcePath: description: The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` member in the corresponding parameter definition matches the name that you specified in the resource path. type: string updateDate: description: The ISO 6801 timestamp indicating when you last modified the resource. format: date-time type: string updatedBy: description: The identifier for the user who last modified the resource. type: string x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml apiSource: description: Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`. nullable: true type: string enum: - USER - API_DISCOVERY apiVersionInfo: additionalProperties: false description: Contains information about a major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai. nullable: true type: object required: - location properties: location: description: The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter. type: string enum: - HEADER - BASE_PATH - QUERY parameterName: description: The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` member is either `HEADER` or `QUERY`. type: string value: description: The expected API version value in an incoming request. type: string x-akamai: file-path: schemas/apiVersionInfo.yaml availableActions: description: The collection of available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2). minItems: 0 nullable: true readOnly: true type: array items: type: string enum: - DELETE - CLONE_ENDPOINT - COMPARE_ENDPOINT - COMPARE_AAG_SETTINGS - COMPARE_RAPID_SETTINGS - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING - ACTIVATE_ON_PRODUCTION - DEACTIVATE_ON_STAGING - DEACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - SHOW_ENDPOINT basePath: description: The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. minLength: 0 nullable: true type: string caseSensitive: description: Whether the URLs and parameters within the endpoint are case sensitive. nullable: true type: boolean clonedFromVersion: description: For cloned endpoints, the unique identifier for the source endpoint version. nullable: true readOnly: true type: integer consumeType: description: The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string. nullable: true type: string enum: - none - json - xml - json/xml - any - urlencoded - json/urlencoded - xml/urlencoded - json/xml/urlencoded contractId: description: The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API. nullable: true readOnly: true type: string createDate: description: The ISO 6801 timestamp indicating when you created the endpoint. format: date-time nullable: true readOnly: true type: string createdBy: description: The identifier for the user who created the endpoint. nullable: true readOnly: true type: string description: description: The description of the endpoint. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. nullable: true type: string discoveredPiiIds: description: The collection of personally identifiable information (PII) in your API parameters discovered by the network. nullable: true type: array items: type: integer endpointHidden: description: Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation. nullable: true readOnly: true type: boolean groupId: description: The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API. nullable: true readOnly: true type: integer isGraphQL: description: Whether the endpoint uses GraphQL to deliver structured content to clients. type: boolean lockVersion: description: The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. readOnly: true type: integer matchPathSegmentParam: default: true description: Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`. nullable: true type: boolean positiveConstrainsEnabled: description: Specifies whether the KSD firewall policies are enabled for the endpoint. nullable: true type: boolean productionStatus: description: The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED productionVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the production network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml protectedByApiKey: description: Whether you enabled API key protection for the endpoint version by making the version private. readOnly: true type: boolean responseConstraintsEnabled: description: Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled. nullable: true readOnly: true type: boolean securityScheme: additionalProperties: false description: Contains information about the key with which users may access the endpoint. nullable: true type: object properties: securitySchemeDetail: additionalProperties: false description: Contains information about the location of the API key. type: object properties: apiKeyLocation: description: The location of the API key in incoming requests, either `cookie`, `header`, or `query` parameter. type: string enum: - cookie - header - query apiKeyName: description: The name of the header, query parameter, or cookie where you located the API key. type: string securitySchemeType: description: The type of security scheme implemented for the endpoint. The only valid value is `apikey`. type: string enum: - apikey source: additionalProperties: false description: Contains information about the import file used to create the endpoint. nullable: true readOnly: true type: object properties: apiVersion: description: The major version of the API defined in the import file. nullable: true readOnly: true type: string specificationVersion: description: The version of the import file's specification. example: 3.0.0 nullable: true readOnly: true type: string type: description: The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`. nullable: true readOnly: true type: string enum: - SWAGGER - RAML x-akamai: file-path: schemas/apiEndpointSourceDto.yaml stagingStatus: description: The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the staging network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml updateDate: description: The ISO 6801 timestamp indicating when you last modified the endpoint. format: date-time nullable: true readOnly: true type: string updatedBy: description: The identifier for the user who last modified the endpoint. nullable: true readOnly: true type: string versionHidden: description: Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation. nullable: true readOnly: true type: boolean versionNumber: description: The endpoint version number. nullable: true type: integer x-akamai: file-path: schemas/apiEndpointWithResourceDto-recurse.yaml '400': description: Invalid data input. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '403': description: You don't have access to the endpoint. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /endpoints/{apiEndPointId}/show: parameters: - description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' in: path name: apiEndPointId required: true schema: example: 1 type: integer x-akamai: file-path: parameters/apiEndPointId-path.yaml 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. operationId: post-endpoint-show summary: Show an endpoint tags: - Endpoints 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 responses: '200': description: Operation succeeded. content: application/json: example: akamaiSecurityRestrictions: null apiEndPointId: 492375 apiEndPointLocked: false apiEndPointName: Bookstore API apiEndPointScheme: http/https apiGatewayEnabled: true basePath: /bookstore caseSensitive: true clonedFromVersion: 1 consumeType: any contractId: C-0N7RAC7 createDate: 2019-06-12T13:06:52+0000 createdBy: adevi description: An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items. endpointHidden: false graphQL: false groupId: 44681 isGraphQL: false lockVersion: 2 positiveConstrainsEnabled: null productionStatus: null protectedByApiKey: true responseConstraintsEnabled: false source: null stagingStatus: null updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin versionHidden: false versionNumber: 1 apiCategoryIds: - 2 - 7 apiEndPointHosts: - bookstore.api.akamai.com availableActions: - DELETE - CLONE_ENDPOINT - ACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING productionVersion: lastError: null status: null timestamp: null versionNumber: null securityScheme: securitySchemeType: apikey securitySchemeDetail: apiKeyLocation: header apiKeyName: apikey stagingVersion: lastError: null status: null timestamp: null versionNumber: null apiResources: - apiResourceClonedFromId: null apiResourceId: 2926712 apiResourceLogicId: 118435 apiResourceName: books createDate: 2019-06-12T13:06:52+0000 createdBy: jperez description: A book item within the bookstore API. link: null lockVersion: 2 private: false resourcePath: /books/{bookId} updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin apiResourceMethods: - apiResourceMethod: GET apiResourceMethodId: 341591 apiResourceMethodLogicId: 184404 apiParameters: - apiParamLogicId: 578116 apiParameterId: 1212945 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string apiResourceMethParamId: 494448 array: false pathParamLocationId: null response: false apiChildParameters: [] - apiResourceMethod: POST apiResourceMethodId: 341592 apiResourceMethodLogicId: 184405 apiParameters: - apiParamLogicId: 578117 apiParameterId: 1212946 apiParameterLocation: path apiParameterName: bookId apiParameterNotes: null apiParameterRequired: true apiParameterType: string apiResourceMethParamId: 494449 array: false pathParamLocationId: null response: false apiChildParameters: [] apiParameterRestriction: arrayRestriction: null numberRangeRestriction: null rangeRestriction: null xmlConversionRule: null lengthRestriction: lengthMax: 15 lengthMin: 3 schema: additionalProperties: false description: Contains information about an endpoint and its associated resources. type: object required: - apiEndPointName - apiEndPointHosts - groupId - contractId - lockVersion properties: akamaiSecurityRestrictions: additionalProperties: false description: Contains information about the Kona Site Defender security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a Kona Site Defender customer. nullable: true type: object properties: ALLOW_ONLY_SPEC_UNDEFINED_METHODS: description: Whether the API allows requests on undefined resources, but only for specific methods. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_BODY_PARAMS: description: Whether the API allows for requests with undefined parameters in body. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_COOKIE_PARAMS: description: Whether the API allows for requests with undefined parameters in cookies. These booleans override members in the Method object. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_HEADER_PARAMS: description: Whether the API allows for requests with undefined parameters in header. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_DELETE: description: Whether the API allows requests on undefined resources using the DELETE method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_GET: description: Whether the API allows requests on undefined resources using the GET method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_HEAD: description: Whether the API allows requesting undefined resources using HEAD method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_OPTIONS: description: Whether the API allows requesting undefined resources using OPTIONS method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PATCH: description: Whether the API allows requesting undefined resources using PATCH method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_POST: description: Whether the API allows requests on undefined resources using the POST method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_METHOD_PUT: description: Whether the API allows requests on undefined resources using the PUT method. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_PARAMS: description: Whether the API allows requesting with undefined parameters. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_QUERY_PARAMS: description: Whether the API allows for requests with undefined parameters in query string. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_RESOURCES: description: Whether the API allows requests on undefined resources. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 ALLOW_UNDEFINED_SPEC_PARAMS: description: Whether the API allows requesting undefined resources, but only for specific locations. Either `1` or `0` for yes or no. type: integer enum: - 0 - 1 MAX_BODY_SIZE: description: The maximum allowed size of a request body. nullable: true type: integer MAX_DOC_DEPTH: description: The maximum depth of nested data elements allowed in a request body. nullable: true type: integer MAX_ELEMENT_NAME_LENGTH: description: The maximum length of an XML element name or JSON object key name allowed in a request body. nullable: true type: integer MAX_INTEGER_VALUE: description: The maximum integer value allowed in a request body. nullable: true type: integer MAX_JSONXML_ELEMENT: description: The maximum number of XML elements, JSON object keys, or array items allowed in a request body. nullable: true type: integer MAX_STRING_LENGTH: description: The maximum length of any string value in a request body. nullable: true type: integer POSITIVE_SECURITY_ENABLED: description: Whether to enforce the API request body and resource constraints as allowlists in your KSD security policies. Either `1` for enabled security constraints, or `0` for disabled. type: integer enum: - 0 - 1 POSITIVE_SECURITY_VERSION: description: Whether to create the API with API Protection 2 or above. Either `1`, `2` for enabled API Protection 2, or `null` for the legacy API. nullable: true type: integer enum: - 1 - 2 RESPONSE_RESTRICTIONS_ENABLED: description: When set to `1`, the API allows for responses with undefined parameters in the response body. Otherwise the value is `0`. type: integer enum: - 0 - 1 apiCategoryIds: description: The category identifiers that apply to the endpoint. The value is `null` for uncategorized endpoints. nullable: true type: array items: type: integer apiEndPointHosts: description: The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint. minItems: 1 type: array items: type: string apiEndPointId: description: The unique identifier for the endpoint. nullable: true readOnly: true type: integer apiEndPointLocked: description: Whether the endpoint version is read-only. nullable: true readOnly: true type: boolean apiEndPointName: description: The name of the endpoint, unique within the account. type: string apiEndPointScheme: description: The URL scheme to which the endpoint may respond, either `http`, `https`, or `http/https` for both. nullable: true type: string enum: - http - https - http/https apiEndPointVersion: description: The unique identifier for the endpoint version. nullable: true readOnly: true type: integer apiGatewayEnabled: default: true description: Whether the API Gateway product should be enabled for the endpoint. If `null`, the member is set to `true`. nullable: true type: boolean apiResources: description: The list of resources assigned to the endpoint. nullable: true type: array items: additionalProperties: false description: Contains information about a resource assigned to an endpoint. type: object required: - apiResourceName - resourcePath properties: apiResourceClonedFromId: description: For cloned resources, the unique identifier for the source resource. nullable: true type: integer apiResourceId: description: The unique identifier for the resource. type: integer apiResourceLogicId: description: The unique identifier for the resource across all endpoint versions. type: integer apiResourceMethodNameLists: description: The list of HTTP methods the resource may respond to. type: array items: type: string apiResourceMethods: description: The list of HTTP methods the resource may respond to. type: array items: additionalProperties: false description: Contains information about an HTTP method to which a resource may respond. type: object required: - apiResourceMethod properties: apiParameters: description: The list of parameter objects assigned to the method. nullable: true type: array items: additionalProperties: false description: Contains information about a method's parameter. type: object required: - apiParameterName - apiParameterType - apiParameterRequired - apiParameterLocation properties: apiChildParameters: description: The collection of child JSON members or XML elements for JSON or XML body type parameters. type: array items: description: A further nested endpoint object. type: object x-akamai: file-path: schemas/apiParameterDto-nested.yaml apiParamLogicId: description: The unique identifier for the parameter across all endpoint versions. readOnly: true type: integer apiParameterContentType: description: The content type of the parameter. Only applicable for top level body parameters. type: string enum: - json - xml - urlencoded - json/xml - any - none apiParameterId: description: The unique identifier for the parameter. readOnly: true type: integer apiParameterLocation: description: The location of the parameter in an HTTP request, either `query`, `header`, `path`, `cookie`, or `body` for a JSON or XML body type parameter. type: string enum: - query - body - header - path - cookie apiParameterName: description: The name of the parameter. If the corresponding `apiParameterLocation` is `path`, ensure that this value matches the parameter name you specified in the `resourcePath`. type: string apiParameterNotes: description: The description to clarify the parameter's function. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`. nullable: true type: string apiParameterRequired: description: Specifies whether the API user needs to specify the parameter. If the corresponding `apiParameterLocation` is `path`, set this member to `true`. type: boolean apiParameterRestriction: additionalProperties: false description: Contains information about restrictions and XML representation rules specified for the parameter. nullable: true type: object properties: arrayRestriction: additionalProperties: false description: Contains information about array restrictions for array type parameters. Define this object only if you enabled the corresponding `array` member. nullable: true type: object properties: collectionFormat: default: csv description: The format of the array that specifies how you separated array values, either the default `csv` for comma separated values, `ssv` for space separated values, `tsv` for tab separated values, `pipes` for pipe separated values, or `multi` for several parameter instances instead of several values for a single instance. type: string enum: - csv - ssv - tsv - pipes - multi maxItems: description: The maximum allowed number of array items. type: integer minItems: description: The minimum allowed number of array items. type: integer uniqueItems: description: Whether the array contains only unique items. type: boolean lengthRestriction: additionalProperties: false description: Contains information about length restrictions for string type parameters. nullable: true type: object properties: lengthMax: description: The maximum allowed number of characters in the string. nullable: true type: integer lengthMin: description: The minimum allowed number of characters in the string. nullable: true type: integer numberRangeRestriction: additionalProperties: false description: Contains information about range restrictions for number type parameters. nullable: true type: object properties: numberRangeMax: description: The maximum range restriction. nullable: true type: number numberRangeMin: description: The minimum range restriction. nullable: true type: number rangeRestriction: additionalProperties: false description: Contains information about range restrictions for integer type parameters. nullable: true type: object properties: rangeMax: description: The maximum range restriction. nullable: true type: integer rangeMin: description: The minimum range restriction. nullable: true type: integer responseRestriction: additionalProperties: false type: object properties: maxBodySize: description: Limit how large the response body can be before tripping the firewall action. The default is `SIZE_6K`. You can choose `SIZE_8K`, `SIZE_12K`, or `NO_LIMIT`, which allows a response of any size. type: string enum: - SIZE_6K - SIZE_8K - SIZE_12K - NO_LIMIT statusCodes: description: The response status codes to match to a particular response body format. A `null` or empty value means the response body definition applies to any response body. nullable: true type: array items: type: integer xmlConversionRule: additionalProperties: false description: Contains information about an XML representation of a JSON-encoded parameter. nullable: true type: object properties: attribute: default: false description: Whether the parameter should be represented as an attribute. type: boolean name: description: The name of the parameter in XML. By default, the XML name is the same as the parameter name specified in the API definition. type: string namespace: description: The XML namespace. type: string prefix: description: The prefix for the XML namespace. type: string wrapped: default: false description: Whether the parameter should be wrapped in a parent XML element. type: boolean x-akamai: file-path: schemas/xmlRestrictionDto.yaml apiParameterType: description: The data type of the parameter, either `string`, `integer`, `number`, `boolean`, or `json/xml` for JSON or XML objects. type: string enum: - string - integer - number - boolean - json/xml apiResourceMethParamId: description: The unique identifier for the parameter's parent method. nullable: true readOnly: true type: integer array: description: Whether the parameter can express more than one value. This member is only applicable for `apiChildParameters` that you can specify if the corresponding `apiParameterLocation` is `body` and the `apiParameterType` is `json/xml`. If you enable this, also define the `arrayRestriction` member. type: boolean pathParamLocationId: description: The index of a segment that includes a path parameter in a resource path. For example, given a path `\books\{bookId}`, the `books` segment has index `0`, and the path parameter `{bookId}` has index `1`. nullable: true type: number response: description: Whether the parameter is within a response type. type: boolean x-akamai: file-path: schemas/apiParameterDto.yaml apiResourceMethod: description: The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`. type: string enum: - GET - PUT - POST - DELETE - HEAD - PATCH - OPTIONS apiResourceMethodId: description: The unique identifier for the resource's allowed method. nullable: true readOnly: true type: integer apiResourceMethodLogicId: description: The unique identifier for the resource's method across all endpoint versions. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiMethodParametersDto.yaml apiResourceName: description: The name of the resource. type: string createDate: description: The ISO 6801 timestamp indicating when you created the resource. format: date-time type: string createdBy: description: The identifier for the user who created the resource. type: string description: description: The description to clarify the resource's function within the API. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. type: string link: description: The location of the navigable resource within this API, for use by API clients. nullable: true type: string lockVersion: description: The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. type: number private: description: Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key. type: boolean resourcePath: description: The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets (`{}`) to define path parameters (for example, `/path/{pathparam}`). If you decide to do so, ensure that the value of the `apiParameterName` member in the corresponding parameter definition matches the name that you specified in the resource path. type: string updateDate: description: The ISO 6801 timestamp indicating when you last modified the resource. format: date-time type: string updatedBy: description: The identifier for the user who last modified the resource. type: string x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml apiSource: description: Specifies if the API's data comes from `API_DISCOVERY` or was provided by the `USER`. nullable: true type: string enum: - USER - API_DISCOVERY apiVersionInfo: additionalProperties: false description: Contains information about a major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai. nullable: true type: object required: - location properties: location: description: The location of the API version value in an incoming request. Either `HEADER`, `BASE_PATH`, or `QUERY` parameter. type: string enum: - HEADER - BASE_PATH - QUERY parameterName: description: The name of the header or query parameter that includes the API version value. This is applicable only if the corresponding `location` member is either `HEADER` or `QUERY`. type: string value: description: The expected API version value in an incoming request. type: string x-akamai: file-path: schemas/apiVersionInfo.yaml availableActions: description: The collection of available actions that you can perform on the endpoint depending on its versions' activation status. For possible values, see [Endpoint.availableActions values](#enumvalues2). minItems: 0 nullable: true readOnly: true type: array items: type: string enum: - DELETE - CLONE_ENDPOINT - COMPARE_ENDPOINT - COMPARE_AAG_SETTINGS - COMPARE_RAPID_SETTINGS - EDIT_ENDPOINT_DEFINITION - ACTIVATE_ON_STAGING - ACTIVATE_ON_PRODUCTION - DEACTIVATE_ON_STAGING - DEACTIVATE_ON_PRODUCTION - HIDE_ENDPOINT - SHOW_ENDPOINT basePath: description: The URL path that serves as a root prefix for all resources' `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. minLength: 0 nullable: true type: string caseSensitive: description: Whether the URLs and parameters within the endpoint are case sensitive. nullable: true type: boolean clonedFromVersion: description: For cloned endpoints, the unique identifier for the source endpoint version. nullable: true readOnly: true type: integer consumeType: description: The content type the endpoint exchanges, either `json`, `xml`, `urlencoded`, `json/xml/urlencoded`, `json/urlencoded`, `json/xml`, or `xml/urlencoded` for multi-format APIs, `any`, or `none`. A `null` value is the same as a `none` string. nullable: true type: string enum: - none - json - xml - json/xml - any - urlencoded - json/urlencoded - xml/urlencoded - json/xml/urlencoded contractId: description: The unique identifier for the contract with Akamai under which you provisioned security and delivery settings for this API. nullable: true readOnly: true type: string createDate: description: The ISO 6801 timestamp indicating when you created the endpoint. format: date-time nullable: true readOnly: true type: string createdBy: description: The identifier for the user who created the endpoint. nullable: true readOnly: true type: string description: description: The description of the endpoint. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string. nullable: true type: string discoveredPiiIds: description: The collection of personally identifiable information (PII) in your API parameters discovered by the network. nullable: true type: array items: type: integer endpointHidden: description: Specifies whether the endpoint is hidden. You cannot activate or delete versions of a hidden endpoint. If you want to do so, you first need to reveal the endpoint by running the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) operation. nullable: true readOnly: true type: boolean groupId: description: The unique identifier for the group in Control Center under which you provisioned security and delivery settings for this API. nullable: true readOnly: true type: integer isGraphQL: description: Whether the endpoint uses GraphQL to deliver structured content to clients. type: boolean lockVersion: description: The identifier for the last modification of an endpoint version, used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. readOnly: true type: integer matchPathSegmentParam: default: true description: Whether or not to include path segment parameters in match criteria, like the `jsessionid` portion of `/ssocookie;jsessionid=434343`. nullable: true type: boolean positiveConstrainsEnabled: description: Specifies whether the KSD firewall policies are enabled for the endpoint. nullable: true type: boolean productionStatus: description: The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED productionVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the production network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml protectedByApiKey: description: Whether you enabled API key protection for the endpoint version by making the version private. readOnly: true type: boolean responseConstraintsEnabled: description: Specifies whether response constraints are enforced for the endpoint. Note that if you enable response constraints but don't define the constraints, it behaves as if disabled. nullable: true readOnly: true type: boolean securityScheme: additionalProperties: false description: Contains information about the key with which users may access the endpoint. nullable: true type: object properties: securitySchemeDetail: additionalProperties: false description: Contains information about the location of the API key. type: object properties: apiKeyLocation: description: The location of the API key in incoming requests, either `cookie`, `header`, or `query` parameter. type: string enum: - cookie - header - query apiKeyName: description: The name of the header, query parameter, or cookie where you located the API key. type: string securitySchemeType: description: The type of security scheme implemented for the endpoint. The only valid value is `apikey`. type: string enum: - apikey source: additionalProperties: false description: Contains information about the import file used to create the endpoint. nullable: true readOnly: true type: object properties: apiVersion: description: The major version of the API defined in the import file. nullable: true readOnly: true type: string specificationVersion: description: The version of the import file's specification. example: 3.0.0 nullable: true readOnly: true type: string type: description: The specification of the import file you uploaded to create the endpoint version. Either `SWAGGER` or `RAML`. nullable: true readOnly: true type: string enum: - SWAGGER - RAML x-akamai: file-path: schemas/apiEndpointSourceDto.yaml stagingStatus: description: The version activation status on the staging network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version was once active but is now inactive, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED stagingVersion: additionalProperties: false description: Contains information about an endpoint version's activation status on the staging network. nullable: true readOnly: true type: object properties: lastError: additionalProperties: false description: Contains information about the last failed activation of the endpoint version. nullable: true type: object properties: status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer status: description: The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network. nullable: true readOnly: true type: string enum: - PENDING - ACTIVE - DEACTIVATED - FAILED timestamp: description: The ISO 6801 timestamp indicating the last update of the activation status. format: date-time nullable: true readOnly: true type: string versionNumber: description: The endpoint version number. nullable: true readOnly: true type: integer x-akamai: file-path: schemas/apiEndpointVersionStatusDto.yaml updateDate: description: The ISO 6801 timestamp indicating when you last modified the endpoint. format: date-time nullable: true readOnly: true type: string updatedBy: description: The identifier for the user who last modified the endpoint. nullable: true readOnly: true type: string versionHidden: description: Specifies whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) operation. nullable: true readOnly: true type: boolean versionNumber: description: The endpoint version number. nullable: true type: integer x-akamai: file-path: schemas/apiEndpointWithResourceDto-recurse.yaml '400': description: Invalid data input. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '403': description: You don't have access to the endpoint. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /api-discovery/host/{hostname}/basepath/{basePath}: parameters: - description: The base64-encoded value of the hostname. in: path name: hostname required: true schema: example: d3d3LmV4YW1wbGUuY29t type: string x-akamai: file-path: parameters/hostname-path.yaml - description: The base64-encoded value of the base path. in: path name: basePath required: true schema: example: L2FwaS92MQ== type: string x-akamai: file-path: parameters/basepath-path.yaml x-akamai: file-path: paths/api-discovery-base-path.yaml path-info: /api-discovery/host/{hostname}/basepath/{basePath} put: description: __All products__ Hide or show an API. You can choose to include or exclude APIs from the [Get discovered APIs](https://techdocs.akamai.com/application-security/reference/get-api-list) response. This operation is per-user. If you hide an API from the response, another of your colleagues will still see that API in the response when they run this operation with their own credentials. externalDocs: description: See documentation for this operation in Akamai's Application Security API url: https://techdocs.akamai.com/application-security/reference/put-api-visibility operationId: put-api-visibility parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string requestBody: content: application/json: example: hidden: true reason: FALSE_POSITIVE schema: additionalProperties: false description: Describes an API's visibility status. properties: hidden: description: Describes an API's visibility status. type: boolean reason: description: The reason you've decided to hide the API from the API list. Use `NOT_ELIGIBLE` if you want to hide it for now and choose what to do with the API at a later time. Use `FALSE_POSITIVE` for APIs you feel are incorrectly included in the data. enum: - NOT_ELIGIBLE - FALSE_POSITIVE type: string required: - hidden type: object x-akamai: file-path: schemas/api-visibility.yaml required: true responses: '200': content: application/json: example: hidden: true reason: FALSE_POSITIVE schema: additionalProperties: false description: Describes an API's visibility status. properties: hidden: description: Describes an API's visibility status. type: boolean reason: description: The reason you've decided to hide the API from the API list. Use `NOT_ELIGIBLE` if you want to hide it for now and choose what to do with the API at a later time. Use `FALSE_POSITIVE` for APIs you feel are incorrectly included in the data. enum: - NOT_ELIGIBLE - FALSE_POSITIVE type: string required: - hidden type: object x-akamai: file-path: schemas/api-visibility.yaml description: Successfully updated the API's action. '400': content: application/json: example: detail: The request could not be understood by the server due to malformed syntax. instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 status: 400 title: Bad Request type: https://problems.luna.akamaiapis.net/appsec/error-types/BAD-REQUEST schema: additionalProperties: true description: Details the errors you can receive. properties: detail: description: The detailed error message. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object instance: description: The non-referenceable URI that indicates the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The error title. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string required: - title - type - detail - instance - status type: object x-akamai: file-path: schemas/problem-details.yaml description: '[Invalid](https://techdocs.akamai.com/application-security/reference/400). Client error, such as invalid or malformed input.' x-akamai: file-path: errors/400-client-read-errors.yaml '403': content: application/problem+json: example: detail: You do not have the necessary access to perform this operation or the requested resource cannot be modified instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 status: 403 title: Forbidden type: https://problems.luna.akamaiapis.net/appsec-resource/error-types/ACCESS-DENIED schema: additionalProperties: true description: Details the errors you can receive. properties: detail: description: The detailed error message. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object instance: description: The non-referenceable URI that indicates the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The error title. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string required: - title - type - detail - instance - status type: object x-akamai: file-path: schemas/problem-details.yaml description: '[Forbidden](https://techdocs.akamai.com/application-security/reference/403). You don''t have permission to write to this resource.' x-akamai: file-path: errors/403-client-write-errors.yaml '404': content: application/problem+json: example: detail: The requested resource is not found instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 status: 404 title: Not Found type: https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND schema: additionalProperties: true description: Details the errors you can receive. properties: detail: description: The detailed error message. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object instance: description: The non-referenceable URI that indicates the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The error title. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string required: - title - type - detail - instance - status type: object x-akamai: file-path: schemas/problem-details.yaml description: '[Not found](https://techdocs.akamai.com/application-security/reference/404). The security policy doesn''t exist, doesn''t carry application layer controls, or no rule with this ID is available for use in this policy.' x-akamai: file-path: errors/404-client-read-errors.yaml '500': content: application/problem+json: example: detail: Internal Server Error instance: 12ab3c45-789d-01ef-2gh3-ijk4l56m78no status: 500 title: Internal Server Error type: internal_server_error schema: additionalProperties: true description: Details the errors you can receive. properties: detail: description: The detailed error message. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object instance: description: The non-referenceable URI that indicates the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The error title. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string required: - title - type - detail - instance - status type: object x-akamai: file-path: schemas/problem-details.yaml description: '[Internal server error](https://techdocs.akamai.com/application-security/reference/500). Something went wrong on our side. Try again in a few minutes or contact support if the error persists.' x-akamai: file-path: errors/500-server-errors.yaml summary: Modify an API's visibility tags: - Endpoints x-akamai: labels: - All products /api-discovery/host/{hostname}/basepath/{basePath}/endpoints: parameters: - description: The base64-encoded value of the hostname. in: path name: hostname required: true schema: example: d3d3LmV4YW1wbGUuY29t type: string x-akamai: file-path: parameters/hostname-path.yaml - description: The base64-encoded value of the base path. in: path name: basePath required: true schema: example: L2FwaS92MQ== type: string x-akamai: file-path: parameters/basepath-path.yaml x-akamai: file-path: paths/api-discovery-base-path-endpoints.yaml path-info: /api-discovery/host/{hostname}/basepath/{basePath}/endpoints post: description: __All products__ Create a new API endpoint or add a resource to an existing endpoint. When you run this operation to add a new resource to an existing API, the API version is cloned for you and the resource is included in the new version. externalDocs: description: See documentation for this operation in Akamai's Application Security API url: https://techdocs.akamai.com/application-security/reference/post-api-endpoint-resource operationId: post-api-endpoint-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). in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string requestBody: content: application/json: example: apiName: New API contractId: C-0N7RAC71 groupId: 12345 schema: additionalProperties: false description: Describes an API endpoint or adding a new resource to an existing endpoint. properties: apiEndpointId: description: A unique identifier for an API endpoint. You need this when adding a resource to an existing endpoint. type: integer apiName: description: The name for this API endpoint. You need this to register an endpoint. type: string contractId: description: A unique identifier for a contract. You need this when registering a new endpoint. type: string groupId: description: A unique identifier for a group. You need this when registering a new endpoint. type: integer version: description: The version number. You need this when adding a resource to an existing endpoint. When a version is read-only, the version is cloned and updates are included in the newly cloned version. type: integer type: object x-akamai: file-path: schemas/endpoint-post.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 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: alfulani 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: hgildong 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: 0 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: 1 schema: additionalProperties: false description: Contains information about an endpoint and its associated resources. properties: akamaiSecurityRestrictions: additionalProperties: false description: Contains information about the Kona Site Defender security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a Kona Site Defender customer. nullable: true properties: ALLOW_UNDEFINED_RESPONSE_BODY_PARAMS: description: When set to `1`, the API allows for responses with undefined parameters in the response body. When `0`, the API does not allow responses with undefined parameters in the response body. enum: - 1 - 0 type: integer ALLOW_UNDEFINED_RESPONSE_HEADER_PARAMS: description: When set to `1`, the API allows for responses with undefined parameters in the response header. When set to `0`, the API does not allow responses with undefined parameters in the response header. enum: - 1 - 0 type: integer MAX_BODY_SIZE: description: The maximum allowed size of a request body. type: integer MAX_DOC_DEPTH: description: The maximum depth of nested data elements allowed in a request body. 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. type: integer MAX_INTEGER_VALUE: description: The maximum integer value allowed in a request body. type: integer MAX_JSONXML_ELEMENT: description: The maximum number of XML elements, JSON object keys, or array items allowed in a request body. type: integer MAX_STRING_LENGTH: description: The maximum length of any string value in a request body. type: integer POSITIVE_SECURITY_ENABLED: description: Whether the API request body and resource constraints should be enforced as allowlists in your KSD security policies. Either `1` for enabled security constraints, or `0` for disabled. 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. At least one hostname is required before activating 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 apiResources: description: The list of resource objects associated with the endpoint. items: additionalProperties: false description: Contains information about a resource associated with 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: The list of HTTP methods the resource may respond to. items: type: string type: array apiResourceMethods: description: The list of 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 type: array apiParamLogicId: description: 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: 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 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 required: - apiResourceMethod type: object 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/application-security/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.yaml type: array apiVersionInfo: additionalProperties: false description: Contains information about a major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai. nullable: true 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.yaml availableActions: description: The collection of available [actions](https://techdocs.akamai.com/application-security/reference/onboarding-status-values) 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 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. nullable: true 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. type: string createdBy: description: The identifier for the user who created the endpoint. 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: 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/application-security/reference/post-endpoint-show) operation. type: boolean groupId: description: The unique identifier for the group in Control Center under which you provisioned 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/application-security/reference/concurrency-control) for details. type: integer positiveConstrainsEnabled: description: Whether the KSD firewall policies are enabled for the endpoint. nullable: true type: boolean productionStatus: description: The version activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version 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 type: string productionVersion: description: Contains information about an endpoint version's activation status on the production network. type: object protectedByApiKey: description: Whether you enabled API key protection for the endpoint version by making the version private. type: boolean securityScheme: additionalProperties: false description: Contains information about the key with which users may access the endpoint. properties: securitySchemeDetail: additionalProperties: false description: Contains information about the location of the API key. properties: apiKeyLocation: description: The location of the API key in incoming requests, either `cookie`, `header`, or `query` parameter. enum: - cookie - header - 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: description: Contains information about the import file used to create the endpoint. nullable: true type: object 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 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 type: string stagingVersion: description: Contains information about 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. type: string updatedBy: description: The identifier for the user who last modified the endpoint. type: string versionHidden: description: 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/application-security/reference/post-version-show) operation. type: boolean versionNumber: description: The endpoint version number. type: integer required: - apiEndPointName - apiEndPointHosts type: object x-akamai: file-path: schemas/api-endpoint-with-resource.yaml description: Successfully registered an endpoint or a new resource to an existing endpoint. '400': content: application/json: example: detail: The request could not be understood by the server due to malformed syntax. instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 status: 400 title: Bad Request type: https://problems.luna.akamaiapis.net/appsec/error-types/BAD-REQUEST schema: additionalProperties: true description: Details the errors you can receive. properties: detail: description: The detailed error message. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object instance: description: The non-referenceable URI that indicates the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The error title. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string required: - title - type - detail - instance - status type: object x-akamai: file-path: schemas/problem-details.yaml description: '[Invalid](https://techdocs.akamai.com/application-security/reference/400). Client error, such as invalid or malformed input.' x-akamai: file-path: errors/400-client-read-errors.yaml '403': content: application/problem+json: example: detail: You do not have the necessary access to perform this operation or the requested resource cannot be modified instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 status: 403 title: Forbidden type: https://problems.luna.akamaiapis.net/appsec-resource/error-types/ACCESS-DENIED schema: additionalProperties: true description: Details the errors you can receive. properties: detail: description: The detailed error message. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object instance: description: The non-referenceable URI that indicates the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The error title. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string required: - title - type - detail - instance - status type: object x-akamai: file-path: schemas/problem-details.yaml description: '[Forbidden](https://techdocs.akamai.com/application-security/reference/403). You don''t have permission to write to this resource.' x-akamai: file-path: errors/403-client-write-errors.yaml '404': content: application/problem+json: example: detail: The requested resource is not found instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 status: 404 title: Not Found type: https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND schema: additionalProperties: true description: Details the errors you can receive. properties: detail: description: The detailed error message. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object instance: description: The non-referenceable URI that indicates the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The error title. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string required: - title - type - detail - instance - status type: object x-akamai: file-path: schemas/problem-details.yaml description: '[Not found](https://techdocs.akamai.com/application-security/reference/404). The security policy doesn''t exist, doesn''t carry application layer controls, or no rule with this ID is available for use in this policy.' x-akamai: file-path: errors/404-client-read-errors.yaml '500': content: application/problem+json: example: detail: Internal Server Error instance: 12ab3c45-789d-01ef-2gh3-ijk4l56m78no status: 500 title: Internal Server Error type: internal_server_error schema: additionalProperties: true description: Details the errors you can receive. properties: detail: description: The detailed error message. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object instance: description: The non-referenceable URI that indicates the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The error title. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string required: - title - type - detail - instance - status type: object x-akamai: file-path: schemas/problem-details.yaml description: '[Internal server error](https://techdocs.akamai.com/application-security/reference/500). Something went wrong on our side. Try again in a few minutes or contact support if the error persists.' x-akamai: file-path: errors/500-server-errors.yaml summary: Create an endpoint or resource tags: - Endpoints x-akamai: labels: - All products get: description: __All products__ Returns API endpoints for the specified hostname and base path. Unlike [Get discovered APIs](https://techdocs.akamai.com/application-security/reference/get-api-list), this operation returns APIs already in your API definitions. When you see a discovered API or a new resource, add it to your definition with [Create an endpoint or resource](https://techdocs.akamai.com/application-security/reference/post-api-endpoint-resource). externalDocs: description: See documentation for this operation in Akamai's Application Security API url: https://techdocs.akamai.com/application-security/reference/get-discovered-api-endpoints operationId: get-discovered-api-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). in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string responses: '200': content: application/json: example: apis: - apiEndPointId: 613101 apiEndPointName: Access Lambda Live latest: basePath: /access-api/v1 version: 3 production: basePath: /access-api/v1 version: 1 staging: basePath: /access-api/v1 version: 2 - apiEndPointId: 613102 apiEndPointName: New Broadcast API latest: basePath: /access-api version: 8 production: basePath: /access-api version: 4 staging: basePath: /access-api version: 5 schema: additionalProperties: false description: Specifies the list of matching API Definitions. properties: apis: description: A list of API Definitions. items: additionalProperties: false description: Specifies the details of an API Definition. properties: apiEndPointId: description: A unique identifier for an API endpoint. type: integer apiEndPointName: description: The name for this API endpoint. type: string latest: additionalProperties: false description: Summarizes this API endpoint's latest version. properties: basePath: description: The API endpoint's base path. type: string version: description: The version number. type: integer type: object production: additionalProperties: false description: Summarizes this API endpoint's current deployment on Akamai's production network. properties: basePath: description: The API endpoint's base path. type: string version: description: The production version number. type: integer type: object staging: additionalProperties: false description: Summarizes this API endpoint's current deployment on Akamai's staging network. properties: basePath: description: The API endpoint's base path. type: string version: description: The staging version number. type: integer type: object required: - apiEndPointId - apiEndPointName - latest type: object x-akamai: file-path: schemas/api-match.yaml type: array type: object x-akamai: file-path: schemas/api-matches.yaml description: Successfully returned the data. '400': content: application/json: example: detail: The request could not be understood by the server due to malformed syntax. instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 status: 400 title: Bad Request type: https://problems.luna.akamaiapis.net/appsec/error-types/BAD-REQUEST schema: additionalProperties: true description: Details the errors you can receive. properties: detail: description: The detailed error message. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object instance: description: The non-referenceable URI that indicates the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The error title. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string required: - title - type - detail - instance - status type: object x-akamai: file-path: schemas/problem-details.yaml description: '[Invalid](https://techdocs.akamai.com/application-security/reference/400). Client error, such as invalid or malformed input.' x-akamai: file-path: errors/400-client-read-errors.yaml '403': content: application/problem+json: example: detail: You do not have the necessary access to perform this operation or the requested resource cannot be modified instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 status: 403 title: Forbidden type: https://problems.luna.akamaiapis.net/appsec-resource/error-types/ACCESS-DENIED schema: additionalProperties: true description: Details the errors you can receive. properties: detail: description: The detailed error message. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object instance: description: The non-referenceable URI that indicates the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The error title. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string required: - title - type - detail - instance - status type: object x-akamai: file-path: schemas/problem-details.yaml description: '[Forbidden](https://techdocs.akamai.com/application-security/reference/403). You don''t have permission to write to this resource.' x-akamai: file-path: errors/403-client-write-errors.yaml '404': content: application/problem+json: example: detail: The requested resource is not found instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 status: 404 title: Not Found type: https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND schema: additionalProperties: true description: Details the errors you can receive. properties: detail: description: The detailed error message. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object instance: description: The non-referenceable URI that indicates the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The error title. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string required: - title - type - detail - instance - status type: object x-akamai: file-path: schemas/problem-details.yaml description: '[Not found](https://techdocs.akamai.com/application-security/reference/404). The security policy doesn''t exist, doesn''t carry application layer controls, or no rule with this ID is available for use in this policy.' x-akamai: file-path: errors/404-client-read-errors.yaml '500': content: application/problem+json: example: detail: Internal Server Error instance: 12ab3c45-789d-01ef-2gh3-ijk4l56m78no status: 500 title: Internal Server Error type: internal_server_error schema: additionalProperties: true description: Details the errors you can receive. properties: detail: description: The detailed error message. type: string fieldErrors: description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field. type: object instance: description: The non-referenceable URI that indicates the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The error title. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string required: - title - type - detail - instance - status type: object x-akamai: file-path: schemas/problem-details.yaml description: '[Internal server error](https://techdocs.akamai.com/application-security/reference/500). Something went wrong on our side. Try again in a few minutes or contact support if the error persists.' x-akamai: file-path: errors/500-server-errors.yaml summary: List discovered API endpoints tags: - Endpoints x-akamai: labels: - All products externalDocs: description: See documentation for Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference x-readme: samples-languages: - curl - python - node