openapi: 3.0.0 info: title: 'Akamai: API Endpoint Definition Access tokens Resources 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: Resources paths: /endpoints/{apiEndPointId}/versions/{versionNumber}/resources: parameters: - description: The unique identifier for the endpoint version. example: '{{versionNumber}}' in: path name: versionNumber required: true schema: example: 1 type: integer x-akamai: file-path: parameters/versionNumber-path.yaml - description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' in: path name: apiEndPointId required: true schema: example: 1 type: integer x-akamai: file-path: parameters/apiEndPointId-path.yaml post: description: Creates a resource in an endpoint version. The resource's full URL (concatenated hostname, `basePath`, and `resourcepath`) needs to be unique within the account. You can only create resources for versions that have never been activated on the staging or production network. operationId: post-resource summary: Create a resource tags: - Resources externalDocs: description: See documentation for this operation in Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference/post-resource requestBody: required: true content: application/json: example: apiResourceName: magazine description: A magazine item within the bookstore API. resourcePath: /magazine/{magazineId} apiResourceMethods: - apiResourceMethod: GET apiParameters: - apiParameterLocation: path apiParameterName: magazineId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string array: false schema: 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. example: '{{apiResourceClonedFromId}}' nullable: true type: integer apiResourceId: description: The unique identifier for the resource. example: '{{apiResourceId}}' type: integer apiResourceLogicId: description: The unique identifier for the resource across all endpoint versions. example: '{{apiResourceLogicId}}' 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. example: '{{apiResourceName}}' type: string createDate: description: The ISO 6801 timestamp indicating when you created the resource. example: '{{createDate}}' format: date-time type: string createdBy: description: The identifier for the user who created the resource. example: '{{createdBy}}' 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. example: '{{description}}' type: string link: description: The location of the navigable resource within this API, for use by API clients. example: '{{link}}' nullable: true type: string lockVersion: description: The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. example: '{{lockVersion}}' type: number private: description: Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key. example: '{{private}}' 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. example: '{{resourcePath}}' type: string updateDate: description: The ISO 6801 timestamp indicating when you last modified the resource. example: '{{updateDate}}' format: date-time type: string updatedBy: description: The identifier for the user who last modified the resource. example: '{{updatedBy}}' type: string x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml responses: '201': description: Saved API Endpoint Resource data. content: application/json: example: apiResourceClonedFromId: null apiResourceId: 2935139 apiResourceLogicId: 126269 apiResourceName: magazine createDate: 2019-06-17T08:26:59+0000 createdBy: tyamada description: A magazine item within the bookstore API. link: null lockVersion: 0 private: false resourcePath: /magazine/{magazineId} updateDate: 2019-06-17T08:26:59+0000 updatedBy: bookstore_admin apiResourceMethods: - apiResourceMethod: GET apiResourceMethodId: 365559 apiResourceMethodLogicId: 205820 apiParameters: - apiParamLogicId: 588309 apiParameterId: 1223250 apiParameterLocation: path apiParameterName: magazineId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string apiResourceMethParamId: 500315 array: false pathParamLocationId: null apiChildParameters: [] schema: 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 headers: Location: description: Relative URL for created API resource. schema: type: string parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string get: description: Lists all resources assigned to an endpoint version. You can use the `apiResourceId` of each returned resource to modify resources individually through the [Edit a resource](https://techdocs.akamai.com/api-definitions/reference/put-version-resource) operation, or run the [Edit a version](https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version) operation to batch-modify a group of resources. operationId: get-endpoint-version-resources summary: List resources tags: - Resources externalDocs: description: See documentation for this operation in Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version-resources responses: '200': description: Gets a List of API Endpoint Resources accessible by the user. content: application/json: schema: 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 example: - apiResourceClonedFromId: null apiResourceId: 2926712 apiResourceLogicId: 118435 apiResourceName: book createDate: 2019-06-12T13:06:52+0000 createdBy: szhang description: A book item within the bookstore API. link: /api-definitions/v1/endpoints/574127/resources lockVersion: 0 private: false resourcePath: /book/{bookId} updateDate: 2019-06-12T13:06:52+0000 updatedBy: bookstore_admin apiResourceMethodNameLists: - POST - GET - apiResourceClonedFromId: null apiResourceId: 2935128 apiResourceLogicId: 126224 apiResourceName: user createDate: 2019-06-17T08:17:23+0000 createdBy: jperez description: A registered bookstore user. link: /api-definitions/v1/endpoints/574127/resources lockVersion: 0 private: false resourcePath: /user/{userId} updateDate: 2019-06-17T08:17:23+0000 updatedBy: bookstore_admin apiResourceMethodNameLists: - POST - GET - PUT - apiResourceClonedFromId: null apiResourceId: 2935139 apiResourceLogicId: 126269 apiResourceName: magazine createDate: 2019-06-17T08:26:59+0000 createdBy: jperez description: A magazine item within the bookstore API. link: /api-definitions/v1/endpoints/574127/resources lockVersion: 0 private: false resourcePath: /magazine/{magazineId} updateDate: 2019-06-17T08:26:59+0000 updatedBy: bookstore_admin apiResourceMethodNameLists: - GET '403': description: You don't have permission to the API endpoint. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /endpoints/{apiEndPointId}/versions/{versionNumber}/resources-detail: parameters: - description: The unique identifier for the endpoint version. example: '{{versionNumber}}' in: path name: versionNumber required: true schema: example: 1 type: integer x-akamai: file-path: parameters/versionNumber-path.yaml - description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' in: path name: apiEndPointId required: true schema: example: 1 type: integer x-akamai: file-path: parameters/apiEndPointId-path.yaml get: description: Returns an endpoint version. Use this operation's response object when modifying an endpoint version through [Edit a version](https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version). Don't use [Get a version summary](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version) for the [Edit a version](https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version) operation. operationId: get-version-details summary: Get a version tags: - Resources externalDocs: description: See documentation for this operation in Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference/get-version-details 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-0N7RAC71 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: hgildong 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 '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: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /endpoints/{apiEndPointId}/versions/{versionNumber}/resources/{apiResourceId}: parameters: - description: The unique identifier for the resource. example: '{{apiResourceId}}' in: path name: apiResourceId required: true schema: type: integer x-akamai: file-path: parameters/apiResourceId-path.yaml - description: The unique identifier for the endpoint version. example: '{{versionNumber}}' in: path name: versionNumber required: true schema: example: 1 type: integer x-akamai: file-path: parameters/versionNumber-path.yaml - description: The unique identifier for the endpoint. example: '{{apiEndPointId}}' in: path name: apiEndPointId required: true schema: example: 1 type: integer x-akamai: file-path: parameters/apiEndPointId-path.yaml get: description: Returns a resource within an endpoint version. operationId: get-endpoint-version-resource summary: Get a resource tags: - Resources externalDocs: description: See documentation for this operation in Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version-resource responses: '200': description: API Endpoint Resource details defined by API Endpoint ID and API Resource ID. content: application/json: example: apiResourceClonedFromId: null apiResourceId: 2935139 apiResourceLogicId: 126269 apiResourceName: magazine createDate: 2019-06-17T08:26:59+0000 createdBy: tyamada description: A magazine item within the bookstore API. link: null lockVersion: 0 private: false resourcePath: /magazine/{magazineId} updateDate: 2019-06-17T08:26:59+0000 updatedBy: bookstore_admin apiResourceMethods: - apiResourceMethod: GET apiResourceMethodId: 365559 apiResourceMethodLogicId: 205820 apiParameters: - apiParamLogicId: 588309 apiParameterId: 1223250 apiParameterLocation: path apiParameterName: magazineId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string apiResourceMethParamId: 500315 array: false pathParamLocationId: null apiChildParameters: [] schema: 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 '403': description: You don't have permission to the API 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 required resource is not found. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string put: description: Updates a resource within an endpoint version. You can edit information about a resource, the methods, and the parameters assigned to a resource. You can only modify resources assigned to versions that have never been activated on the staging or production network. operationId: put-version-resource summary: Edit a resource tags: - Resources externalDocs: description: See documentation for this operation in Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference/put-version-resource requestBody: required: true content: application/json: example: apiResourceClonedFromId: null apiResourceId: 2935139 apiResourceLogicId: 126269 apiResourceName: magazine createDate: 2019-06-17T08:26:59+0000 createdBy: alfulani description: A magazine item within the bookstore API. link: null lockVersion: 0 private: false resourcePath: /magazine/{magazineId} updateDate: 2019-06-17T08:26:59+0000 updatedBy: bookstore_admin apiResourceMethods: - apiResourceMethod: GET apiResourceMethodId: 365559 apiResourceMethodLogicId: 205820 apiParameters: - apiParamLogicId: 588309 apiParameterId: 1223250 apiParameterLocation: path apiParameterName: magazineId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string apiResourceMethParamId: 500315 array: false pathParamLocationId: null apiChildParameters: [] schema: 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. example: '{{apiResourceClonedFromId}}' nullable: true type: integer apiResourceId: description: The unique identifier for the resource. example: '{{apiResourceId}}' type: integer apiResourceLogicId: description: The unique identifier for the resource across all endpoint versions. example: '{{apiResourceLogicId}}' 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. example: '{{apiResourceName}}' type: string createDate: description: The ISO 6801 timestamp indicating when you created the resource. example: '{{createDate}}' format: date-time type: string createdBy: description: The identifier for the user who created the resource. example: '{{createdBy}}' 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. example: '{{description}}' type: string link: description: The location of the navigable resource within this API, for use by API clients. example: '{{link}}' nullable: true type: string lockVersion: description: The identifier used for optimistic locking. See [Concurrency control](https://techdocs.akamai.com/api-definitions/reference/concurrency-control) for details. example: '{{lockVersion}}' type: number private: description: Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key. example: '{{private}}' 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. example: '{{resourcePath}}' type: string updateDate: description: The ISO 6801 timestamp indicating when you last modified the resource. example: '{{updateDate}}' format: date-time type: string updatedBy: description: The identifier for the user who last modified the resource. example: '{{updatedBy}}' type: string x-akamai: file-path: schemas/apiResourceMethParamsDto.yaml responses: '200': description: Updated API Endpoint Resource Details. content: application/json: example: apiResourceClonedFromId: null apiResourceId: 2935139 apiResourceLogicId: 126269 apiResourceName: magazine createDate: 2019-06-17T08:26:59+0000 createdBy: adevi description: A magazine item within the bookstore API. link: null lockVersion: 0 private: false resourcePath: /magazine/{magazineId} updateDate: 2019-06-17T08:26:59+0000 updatedBy: bookstore_admin apiResourceMethods: - apiResourceMethod: GET apiResourceMethodId: 365559 apiResourceMethodLogicId: 205820 apiParameters: - apiParamLogicId: 588309 apiParameterId: 1223250 apiParameterLocation: path apiParameterName: magazineId apiParameterNotes: null apiParameterRequired: true apiParameterRestriction: null apiParameterType: string apiResourceMethParamId: 500315 array: false pathParamLocationId: null apiChildParameters: [] schema: 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 '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 permission to the API 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 required resource is not found. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml '409': description: After you get the data, you modify the API endpoint resource. You have to retrieve the updated data before update. content: application/problem+json: schema: additionalProperties: false description: Contains debugging information for error responses. type: object properties: detail: description: The detailed error message. type: string errors: description: The collection of nested error responses. type: array items: additionalProperties: false description: A further nested problem detail object. type: object x-akamai: file-path: schemas/httpProblemDetails-recurse.yaml instance: description: The non-referenceable URL for the error instance. example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749 type: string status: description: The HTTP status code. example: 404 type: integer title: description: The title of the error. example: Not Found type: string type: description: The URL for the error type. example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND type: string x-akamai: file-path: schemas/httpProblemDetails.yaml parameters: - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string delete: description: Removes a resource from an endpoint version. You can only remove resources assigned to versions that have never been activated on the staging or production network. operationId: delete-endpoint-version-resource summary: Delete a resource tags: - Resources externalDocs: description: See documentation for this operation in Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference/delete-endpoint-version-resource 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 or resource 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 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