openapi: 3.0.0 info: description: 'Manage your configurations for Kona Site Defender, Web Application Protector, and Client Reputation. ' license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: 'Akamai: Application Security Activation history API endpoints API' version: v1 servers: - url: https://{hostname}/appsec/v1 tags: - description: Get the list of API endpoints associated with a security policy. name: API endpoints paths: /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/api-endpoints: parameters: - description: A unique identifier for each configuration. example: '{{configId}}' in: path name: configId required: true schema: example: 77653 format: int64 type: integer x-akamai: file-path: parameters/config-id-path.yaml - description: A unique identifier for each version of a configuration. example: '{{versionNumber}}' in: path name: versionNumber required: true schema: example: 25 type: integer x-akamai: file-path: parameters/version-number-path.yaml - description: A unique identifier for a security policy. example: '{{policyId}}' in: path name: policyId required: true schema: example: boBF_19288 type: string x-akamai: file-path: parameters/policy-id-path.yaml x-akamai: file-path: paths/policy-api-endpoints.yaml path-info: /configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/api-endpoints get: description: List the API endpoints associated with a security policy. This operation only lists the endpoints. To manage them, use [Register an endpoint](https://techdocs.akamai.com/api-gateway/reference/post-endpoints) from the API Endpoint Definition API. _Products:_ Kona Site Defender, App & API Protector with the Advanced Security module. externalDocs: description: See documentation for this operation in Akamai's Application Security API url: https://techdocs.akamai.com/application-security/reference/get-api-endpoints operationId: get-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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string responses: '200': content: application/json: example: apiEndpoints: - apiEndPointHosts: - sg.akamai.com basePath: /v1/orders id: 619183 name: Orders productionVersion: status: ACTIVE versionNumber: 1 requestConstraintsEnabled: false stagingVersion: status: ACTIVE versionNumber: 1 - apiEndPointHosts: - sg.akamai.com basePath: /v1/catalog id: 624913 name: Catalog productionVersion: status: ACTIVE versionNumber: 1 requestConstraintsEnabled: true stagingVersion: status: ACTIVE versionNumber: 1 schema: additionalProperties: false description: Specifies each API's basic metadata and current deployment status. properties: apiEndpoints: description: The list of API Endpoints. items: additionalProperties: false description: API Endpoint JSON Properties. properties: apiEndPointHosts: description: The hosts associated with this API endpoint. items: description: The set of hostnames that allow access to this API. type: string type: array apiResources: description: A list of this API endpoint's functional URL patterns. items: additionalProperties: false properties: id: description: A unique identifier an API resource. type: integer name: description: The name for an API resource. type: string path: description: The path for an API resource. type: string type: object type: array basePath: description: The API endpoint's base path. type: string categories: description: The categories this API endpoint belongs to. items: additionalProperties: false properties: categoryId: description: A unique identifier for a category. type: integer categoryName: description: The name for a category. type: string type: object type: array id: description: A unique identifier for an API endpoint. type: integer name: description: The name for this API endpoint. type: string productionVersion: additionalProperties: false description: Summarizes this API endpoint's current deployment on Akamai's production network. properties: status: description: The production status. type: string versionNumber: description: The production version number. nullable: true type: integer type: object requestConstraintsEnabled: description: Whether to allow API constraints for this endpoint. type: boolean stagingVersion: additionalProperties: false description: Summarizes this API endpoint's current deployment on Akamai's staging network. properties: status: description: The staging status. type: string versionNumber: description: The staging version number. nullable: true type: integer type: object type: object x-akamai: file-path: schemas/api-endpoint.yaml type: array required: - apiEndpoints type: object x-akamai: file-path: schemas/api-endpoints-get-200.yaml description: Successfully retrieved API endpoints. '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: additionalProperties: description: Fields that provide additional details about the problem. type: string 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 '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: additionalProperties: description: Fields that provide additional details about the problem. type: string 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 named 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: additionalProperties: description: Fields that provide additional details about the problem. type: string 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, and contact support if the error persists.' x-akamai: file-path: errors/500-server-errors.yaml summary: Akamai API Security List API Endpoints tags: - API endpoints externalDocs: description: See documentation for Akamai's Application Security API url: https://techdocs.akamai.com/application-security/reference x-readme: samples-languages: - curl - python - node