{ "components": { "schemas": { "permissions": { "additionalProperties": false, "description": "Verifies your ECCU permissions. If you have `viewEccuFile` and `submitEccuFile` permissions, all API functionality is available to you.", "properties": { "submitEccuRequest": { "default": false, "description": "Verifies your permission to submit a refresh request.", "type": "boolean" }, "viewEccuRequest": { "default": false, "description": "Verifies your permission to view a refresh request.", "type": "boolean" } }, "required": [ "submitEccuRequest", "viewEccuRequest" ], "type": "object", "x-akamai": { "file-path": "schemas/permissions.yaml" } } } }, "externalDocs": { "description": "See documentation for Akamai's Enhanced Content Control Utility API", "url": "https://techdocs.akamai.com/eccu/reference" }, "info": { "description": "Refresh content cached on the edge network based on directory, file extension, or other logic.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: Enhanced Content Control Utility API", "version": "v1" }, "openapi": "3.0.0", "paths": { "/permissions": { "get": { "description": "Returns the ECCU permissions. If the response's `submitEccuRequest` member is enabled, you can run the [Create an ECCU request](https://techdocs.akamai.com/eccu/reference/post-request) operation to invalidate content.", "externalDocs": { "description": "See documentation for this operation in Akamai's Enhanced Content Control Utility API", "url": "https://techdocs.akamai.com/eccu/reference/get-permissions" }, "operationId": "get-permissions", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "submitEccuRequest": true, "viewEccuRequest": true }, "schema": { "additionalProperties": false, "description": "Verifies your ECCU permissions. If you have `viewEccuFile` and `submitEccuFile` permissions, all API functionality is available to you.", "properties": { "submitEccuRequest": { "default": false, "description": "Verifies your permission to submit a refresh request.", "type": "boolean" }, "viewEccuRequest": { "default": false, "description": "Verifies your permission to view a refresh request.", "type": "boolean" } }, "required": [ "submitEccuRequest", "viewEccuRequest" ], "type": "object", "x-akamai": { "file-path": "schemas/permissions.yaml" } } } }, "description": "List permissions." } }, "summary": "List permissions", "tags": [ "Permissions" ] }, "x-akamai": { "file-path": "paths/permissions.yaml", "path-info": "/permissions" } }, "/properties": { "get": { "description": "Returns the digital properties that you can apply ECCU refresh requests to.", "externalDocs": { "description": "See documentation for this operation in Akamai's Enhanced Content Control Utility API", "url": "https://techdocs.akamai.com/eccu/reference/get-properties" }, "operationId": "get-properties", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "properties": [ { "propertyName": "www.example.com", "propertyNameExactMatch": true, "propertyType": "HOST_HEADER" }, { "propertyName": "www.another-example.com", "propertyNameExactMatch": false, "propertyType": "ARL_TOKEN" }, { "propertyName": "example2.com", "propertyNameExactMatch": true, "propertyType": "ARL_TOKEN" } ] }, "schema": { "additionalProperties": false, "description": "Contains a collection of properties.", "properties": { "properties": { "description": "Collects data about each digital property under your account that you need to make an ECCU request for.", "items": { "additionalProperties": false, "description": "Collects data about each digital property under your account that you need to make an ECCU request for.", "properties": { "propertyName": { "description": "Identifies the digital property whose content you want to refresh.", "minLength": 1, "type": "string" }, "propertyNameExactMatch": { "description": "Specifies whether to exactly match the full string of the `propertyName`, or to perform an inexact right hand side (RHS) substring match. For example, with `propertyNameExactMatch` enabled, `example.com` does not match `www.example.com`.", "type": "boolean" }, "propertyType": { "description": "Specifies the type of digital property. Either `ARL_TOKEN` or `HOST_HEADER`. This tells the edge network whether the purge information is contained in the ARL, or in a configuration file. The ARL is similar to the URL, but the ARL is specifically defined for objects to be served by the edge network. There are two types of ARLs, v1 and v2. For details, see the [Purge Cache documentation](https://techdocs.akamai.com/purge-cache/docs/digital-props).", "enum": [ "ARL_TOKEN", "HOST_HEADER" ], "type": "string" } }, "required": [ "propertyName", "propertyNameExactMatch", "propertyType" ], "type": "object", "x-akamai": { "file-path": "schemas/property.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "properties" ], "type": "object", "x-akamai": { "file-path": "schemas/properties.yaml" } } } }, "description": "List properties." } }, "summary": "List properties", "tags": [ "Properties" ] }, "x-akamai": { "file-path": "paths/properties.yaml", "path-info": "/properties" } }, "/requests": { "post": { "description": "Creates a new ECCU refresh request.", "externalDocs": { "description": "See documentation for this operation in Akamai's Enhanced Content Control Utility API", "url": "https://techdocs.akamai.com/eccu/reference/post-request" }, "operationId": "post-request", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "metadata": "\n \n \n \n now\n \n \n", "notes": "Invalidate images in store ahead of holiday", "propertyName": "www.example.com", "propertyNameExactMatch": true, "propertyType": "HOST_HEADER", "requestName": "Invalidate Images", "statusUpdateEmails": [ "john.doe@example.com" ] }, "schema": { "additionalProperties": false, "description": "Collects all of the data that you need to make an ECCU request for.", "properties": { "metadata": { "description": "Contains tags that define a refresh request based on request parameters such as directory path and file extension. Use only ASCII characters. For more information on the format of an ECCU request file and metadata tag usage, see [Enhanced CCU Request Format](https://techdocs.akamai.com/purge-cache/docs/create-eccu-req-file).", "minLength": 1, "type": "string" }, "notes": { "description": "In addition to the `requestName`, this provides information to help you track the refresh request.", "minLength": 1, "type": "string" }, "propertyName": { "description": "Identifies the digital property whose content you want to refresh.", "minLength": 1, "type": "string" }, "propertyNameExactMatch": { "description": "Specifies whether to exactly match the full string of the `propertyName`, or to perform an inexact right hand side (RHS) substring match. For example, with `propertyNameExactMatch` enabled, `example.com` doesn't match `www.example.com`.", "type": "boolean" }, "propertyType": { "description": "Specifies the type of digital property. Either `ARL_TOKEN` or `HOST_HEADER`. This tells the edge network whether the purge information is contained in the ARL, or in a configuration file. The ARL is similar to the URL, but the ARL is specifically defined for objects to be served by the edge network. There are two types of ARLs, v1 and v2. For details, see the [Purge Cache documentation](https://techdocs.akamai.com/purge-cache/docs/digital-props).", "enum": [ "ARL_TOKEN", "HOST_HEADER" ], "type": "string" }, "requestName": { "description": "The name that you give to the refresh request.", "minLength": 1, "type": "string" }, "statusUpdateEmails": { "description": "A list of email addresses to notify when the `status` of the refresh request changes.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "version": { "description": "Use this to mark differences in your refresh requests.", "minLength": 1, "type": "string" } }, "required": [ "propertyName", "propertyType", "propertyNameExactMatch", "metadata" ], "type": "object", "x-akamai": { "file-path": "schemas/request-post.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "metadata": "\n \n \n \n now\n \n \n", "notes": "Invalidate images in store", "propertyName": "www.example.com", "propertyNameExactMatch": true, "propertyType": "HOST_HEADER", "requestDate": "2018-11-30T16:25:15.000+0000", "requestId": 263529762, "requestName": "Invalidate Images", "requestor": "john.doe@example.com", "status": "PENDING", "statusMessage": "File uploaded and awaiting validation", "statusUpdateDate": "2018-11-30T16:25:15.000+0000", "statusUpdateEmails": [ "john.doe@example.com" ] }, "schema": { "additionalProperties": false, "description": "Provides information about an ECCU request.", "properties": { "extendedStatusMessage": { "description": "Further detail about the status of a request. Typically there is more information provided for a failed refresh request.", "minLength": 1, "type": "string" }, "metadata": { "description": "Contains tags that define a refresh request based on request parameters such as directory path and file extension. Use only ASCII characters. For more information on the format of an ECCU request file and metadata tag usage, see [Enhanced CCU Request Format](https://techdocs.akamai.com/eccu/docs/eccu-request-format).", "minLength": 1, "type": "string" }, "notes": { "description": "In addition to the `requestName`, this provides information to help you track the refresh request.", "minLength": 1, "type": "string" }, "propertyName": { "description": "Identifies the digital property whose content you want to refresh.", "minLength": 1, "type": "string" }, "propertyNameExactMatch": { "description": "Specifies whether to exactly match the full string of the `propertyName`, or to perform an inexact right hand side (RHS) substring match. For example, with `propertyNameExactMatch` enabled, `example.com` doesn't match `www.example.com`.", "type": "boolean" }, "propertyType": { "description": "Specifies the type of digital property. Either `ARL_TOKEN` or `HOST_HEADER`. This tells the edge network whether the purge information is contained in the ARL, or in a configuration file. The ARL is similar to the URL, but the ARL is specifically defined for objects to be served by the edge network. There are two types of ARLs, v1 and v2. For details, see the [Purge Cache documentation](https://techdocs.akamai.com/purge-cache/docs/digital-props).", "enum": [ "ARL_TOKEN", "HOST_HEADER" ], "type": "string" }, "requestDate": { "description": "The time the refresh request was submitted, in ISO 8601 format.", "format": "date-time", "type": "string" }, "requestId": { "description": "A unique identifier for the refresh request. Use this to track issues with the request.", "minimum": 0, "type": "integer" }, "requestName": { "description": "The name that you give to the refresh request.", "minLength": 1, "type": "string" }, "requestor": { "description": "The username of the person who submitted the request. For example, `john.doe@example.com`.", "minLength": 1, "type": "string" }, "status": { "description": "Specifies the condition of the refresh request. Possible values are `PENDING`, `SUCCEEDED`, `FAILED`, or `IGNORED`. If you form the `metadata` incorrectly, the refresh request will fail.", "enum": [ "FAILED", "IGNORED", "PENDING", "SUCCEEDED" ], "type": "string" }, "statusMessage": { "description": "Details about the `status` of the refresh request.", "minLength": 1, "type": "string" }, "statusUpdateDate": { "description": "The time the refresh request's `status` last changed, in ISO 8601 format.", "format": "date-time", "type": "string" }, "statusUpdateEmails": { "description": "A list of email addresses to notify when the `status` of the refresh request changes.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "version": { "description": "Use this to mark differences in your refresh requests.", "minLength": 1, "type": "string" } }, "required": [ "propertyName", "propertyNameExactMatch", "propertyType", "requestDate", "requestId", "status", "statusUpdateDate" ], "type": "object", "x-akamai": { "file-path": "schemas/request.yaml" } } } }, "description": "The operation was successful.", "headers": { "Location": { "description": "The path to the newly created ECCU request.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "Property specified by propertyName, propertyType, and propertyNameExactMatch could not be found", "errors": [], "instance": "/eccu-api/error-instances/b39849c6-02ac-4084-9627-174e91a8fecd", "method": "POST", "requestTime": "2023-04-17T08:11:55.482297Z", "status": 400, "title": "Property Not Found", "type": "https://problems.luna.akamaiapis.net/eccu-api/property-not-found" }, "schema": { "additionalProperties": true, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Specifies more details and indicates the cause of the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "A nested problem object.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "Links to the error instance.", "format": "uri", "type": "string" }, "status": { "description": "Specifies the HTTP status code.", "minimum": 0, "type": "integer" }, "title": { "description": "Summarizes the problem.", "minLength": 1, "type": "string" }, "type": { "description": "Non-navigable URI that identifies each error case.", "format": "uri", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/eccu/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } } }, "summary": "Create an ECCU request", "tags": [ "ECCU requests" ] }, "get": { "description": "Returns a summary of submitted ECCU refresh requests under your account. Use this to view the `status` of all refresh requests.", "externalDocs": { "description": "See documentation for this operation in Akamai's Enhanced Content Control Utility API", "url": "https://techdocs.akamai.com/eccu/reference/get-requests" }, "operationId": "get-requests", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "requests": [ { "notes": "Invalidate images in store", "propertyName": "www.example.com", "propertyNameExactMatch": true, "propertyType": "HOST_HEADER", "requestDate": "2018-11-30T16:25:15.000+0000", "requestId": 263529762, "requestName": "Invalidate Images", "requestor": "john.doe@example.com", "status": "PENDING", "statusMessage": "File uploaded and awaiting validation", "statusUpdateDate": "2018-11-30T16:25:15.000+0000", "statusUpdateEmails": [ "john.doe@example.com" ] }, { "notes": "Invalidate more images", "propertyName": "www.another-example.com", "propertyNameExactMatch": true, "propertyType": "HOST_HEADER", "requestDate": "2018-12-11T16:25:15.000+0000", "requestId": 263529762, "requestName": "Invalidate Images", "requestor": "john.doe@example.com", "status": "PENDING", "statusMessage": "File uploaded and awaiting validation", "statusUpdateDate": "2018-12-11T16:25:15.000+0000", "statusUpdateEmails": [ "john.doe@example.com" ] } ] }, "schema": { "additionalProperties": false, "description": "Contains a collection of ECCU requests.", "properties": { "requests": { "description": "Provides information about an ECCU request.", "items": { "additionalProperties": false, "description": "Provides information about an ECCU request.", "properties": { "extendedStatusMessage": { "description": "Further detail about the status of a request. Typically there is more information provided for a failed refresh request.", "minLength": 1, "type": "string" }, "notes": { "description": "Contains tags that define a refresh request based on request parameters such as directory path and file extension. Use only ASCII characters. For more information on the format of an ECCU request file and metadata tag usage, see [Create the ECCU request file](https://techdocs.akamai.com/purge-cache/docs/create-eccu-req-file).", "minLength": 1, "type": "string" }, "propertyName": { "description": "Identifies the digital property whose content you want to refresh.", "minLength": 1, "type": "string" }, "propertyNameExactMatch": { "description": "Specifies whether to exactly match the full string of the `propertyName`, or to perform an inexact right hand side (RHS) substring match. For example, with `propertyNameExactMatch` enabled, `example.com` doesn't match `www.example.com`.", "type": "boolean" }, "propertyType": { "description": "Specifies the type of digital property. Either `ARL_TOKEN` or `HOST_HEADER`. This tells the edge network whether the purge information is contained in the ARL, or in a configuration file. The ARL is similar to the URL, but the ARL is specifically defined for objects to be served by the edge network. There are two types of ARLs, v1 and v2. For details, see the [Purge Cache documentation](https://techdocs.akamai.com/purge-cache/docs/digital-props).", "enum": [ "ARL_TOKEN", "HOST_HEADER" ], "type": "string" }, "requestDate": { "description": "The time the refresh request was submitted, in ISO 8601 format.", "format": "date-time", "type": "string" }, "requestId": { "description": "A unique identifier for the refresh request. Use this to track issues with the request.", "minimum": 0, "type": "integer" }, "requestName": { "description": "The name that you give to the refresh request.", "minLength": 1, "type": "string" }, "requestor": { "description": "The username of the person who submitted the request. For example, `john.doe@example.com`.", "minLength": 1, "type": "string" }, "status": { "description": "Specifies the condition of the refresh request. Possible values are `PENDING`, `SUCCEEDED`, `FAILED`, or `IGNORED`. If you form the `metadata` incorrectly, the refresh request fails.", "enum": [ "FAILED", "IGNORED", "PENDING", "SUCCEEDED" ], "type": "string" }, "statusMessage": { "description": "Details about the `status` of the refresh request.", "minLength": 1, "type": "string" }, "statusUpdateDate": { "description": "The time the refresh request's `status` last changed, in ISO 8601 format.", "format": "date-time", "type": "string" }, "statusUpdateEmails": { "description": "A list of email addresses to notify when the `status` of the refresh request changes.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "version": { "description": "Use this to mark differences in your refresh requests.", "minLength": 1, "type": "string" } }, "required": [ "propertyName", "propertyNameExactMatch", "propertyType" ], "type": "object", "x-akamai": { "file-path": "schemas/request-list-item.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "requests" ], "type": "object", "x-akamai": { "file-path": "schemas/request-list.yaml" } } } }, "description": "List ECCU requests." } }, "summary": "List ECCU requests", "tags": [ "ECCU requests" ] }, "x-akamai": { "file-path": "paths/requests.yaml", "path-info": "/requests" } }, "/requests/{requestId}": { "get": { "description": "Returns a submitted refresh request. Run this operation if you want details on the request's `metadata`. Otherwise, you can run [List ECCU requests](https://techdocs.akamai.com/eccu/reference/get-requests) to check the `status` of all refresh requests.", "externalDocs": { "description": "See documentation for this operation in Akamai's Enhanced Content Control Utility API", "url": "https://techdocs.akamai.com/eccu/reference/get-request" }, "operationId": "get-request", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "metadata": "\n \n \n \n now\n \n \n", "notes": "Invalidate images in store", "propertyName": "www.example.com", "propertyNameExactMatch": true, "propertyType": "HOST_HEADER", "requestDate": "2018-11-30T16:25:15.000+0000", "requestId": 263529762, "requestName": "Invalidate Images", "requestor": "john.doe@example.com", "status": "PENDING", "statusMessage": "File uploaded and awaiting validation", "statusUpdateDate": "2018-11-30T16:25:15.000+0000", "statusUpdateEmails": [ "john.doe@example.com" ] }, "schema": { "additionalProperties": false, "description": "Provides information about an ECCU request.", "properties": { "extendedStatusMessage": { "description": "Further detail about the status of a request. Typically there is more information provided for a failed refresh request.", "minLength": 1, "type": "string" }, "metadata": { "description": "Contains tags that define a refresh request based on request parameters such as directory path and file extension. Use only ASCII characters. For more information on the format of an ECCU request file and metadata tag usage, see [Enhanced CCU Request Format](https://techdocs.akamai.com/eccu/docs/eccu-request-format).", "minLength": 1, "type": "string" }, "notes": { "description": "In addition to the `requestName`, this provides information to help you track the refresh request.", "minLength": 1, "type": "string" }, "propertyName": { "description": "Identifies the digital property whose content you want to refresh.", "minLength": 1, "type": "string" }, "propertyNameExactMatch": { "description": "Specifies whether to exactly match the full string of the `propertyName`, or to perform an inexact right hand side (RHS) substring match. For example, with `propertyNameExactMatch` enabled, `example.com` doesn't match `www.example.com`.", "type": "boolean" }, "propertyType": { "description": "Specifies the type of digital property. Either `ARL_TOKEN` or `HOST_HEADER`. This tells the edge network whether the purge information is contained in the ARL, or in a configuration file. The ARL is similar to the URL, but the ARL is specifically defined for objects to be served by the edge network. There are two types of ARLs, v1 and v2. For details, see the [Purge Cache documentation](https://techdocs.akamai.com/purge-cache/docs/digital-props).", "enum": [ "ARL_TOKEN", "HOST_HEADER" ], "type": "string" }, "requestDate": { "description": "The time the refresh request was submitted, in ISO 8601 format.", "format": "date-time", "type": "string" }, "requestId": { "description": "A unique identifier for the refresh request. Use this to track issues with the request.", "minimum": 0, "type": "integer" }, "requestName": { "description": "The name that you give to the refresh request.", "minLength": 1, "type": "string" }, "requestor": { "description": "The username of the person who submitted the request. For example, `john.doe@example.com`.", "minLength": 1, "type": "string" }, "status": { "description": "Specifies the condition of the refresh request. Possible values are `PENDING`, `SUCCEEDED`, `FAILED`, or `IGNORED`. If you form the `metadata` incorrectly, the refresh request will fail.", "enum": [ "FAILED", "IGNORED", "PENDING", "SUCCEEDED" ], "type": "string" }, "statusMessage": { "description": "Details about the `status` of the refresh request.", "minLength": 1, "type": "string" }, "statusUpdateDate": { "description": "The time the refresh request's `status` last changed, in ISO 8601 format.", "format": "date-time", "type": "string" }, "statusUpdateEmails": { "description": "A list of email addresses to notify when the `status` of the refresh request changes.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "version": { "description": "Use this to mark differences in your refresh requests.", "minLength": 1, "type": "string" } }, "required": [ "propertyName", "propertyNameExactMatch", "propertyType", "requestDate", "requestId", "status", "statusUpdateDate" ], "type": "object", "x-akamai": { "file-path": "schemas/request.yaml" } } } }, "description": "The operation was successful." }, "404": { "content": { "application/json": { "example": { "detail": "Could not find ECCU Request for specified requestId", "errors": [], "instance": "/eccu-api/error-instances/b39849c6-02ac-4084-9627-174e91a8fecd", "method": "GET", "requestTime": "2023-04-17T08:13:20.172527Z", "status": 404, "title": "ECCU Request For ID Not Found ", "type": "https://problems.luna.akamaiapis.net/eccu-api/eccu-request-for-id-not-found" }, "schema": { "additionalProperties": true, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Specifies more details and indicates the cause of the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "A nested problem object.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "Links to the error instance.", "format": "uri", "type": "string" }, "status": { "description": "Specifies the HTTP status code.", "minimum": 0, "type": "integer" }, "title": { "description": "Summarizes the problem.", "minLength": 1, "type": "string" }, "type": { "description": "Non-navigable URI that identifies each error case.", "format": "uri", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/eccu/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } } }, "summary": "Get an ECCU request", "tags": [ "ECCU requests" ] }, "delete": { "description": "Removes the refresh request from the list of submitted requests only. This operation doesn't stop the refresh request from being processed.", "externalDocs": { "description": "See documentation for this operation in Akamai's Enhanced Content Control Utility API", "url": "https://techdocs.akamai.com/eccu/reference/delete-request" }, "operationId": "delete-request", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "Remove an ECCU request." } }, "summary": "Remove an ECCU request", "tags": [ "ECCU requests" ] }, "parameters": [ { "description": "Unique identifier for an ECCU request.", "in": "path", "name": "requestId", "required": true, "schema": { "example": 263529539, "type": "integer" }, "x-akamai": { "file-path": "parameters/request-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/request.yaml", "path-info": "/requests/{requestId}" } } }, "servers": [ { "url": "https://{hostname}/eccu-api/v1" } ], "tags": [], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } }