{ "components": { "headers": { "location-header": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } }, "parameters": { "certificate-id-path": { "description": "A unique identifier for the certificate.", "in": "path", "name": "certificateId", "required": true, "schema": { "example": 5001, "type": "integer" }, "x-akamai": { "file-path": "parameters/certificate-id-path.yaml" } }, "certificate-query-params-include-certificate": { "description": "When `true`, the response includes the certificate block, `false` by default.", "in": "query", "name": "include-certificate", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/certificate-query-params-include-certificate.yaml" } }, "config-id-path": { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } }, "debuggable-debug": { "description": "Indicates if the response includes ISO 8601 timestamp fields for debugging, `false` by default.", "in": "query", "name": "debug", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/debuggable-debug.yaml" } }, "if-match-header": { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } } }, "responses": { "insufficient-permissions-403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "not-found-404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "unauthorized-401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "validation-error-400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } } }, "schemas": { "certificate": { "additionalProperties": false, "description": "Contains data about a TLS certificate.", "properties": { "caMode": { "description": "Mode of the certificate, either `CUSTOMER` or `AKAMAI`.", "enum": [ "CUSTOMER", "AKAMAI" ], "type": "string" }, "certificate": { "description": "Value of the certificate in PEM format. ASCII, base64-encoded text starting with `-----BEGIN CERTIFICATE-----` and ending with `-----END CERTIFICATE-----`.", "type": "string" }, "certificateId": { "description": "__Read-only__ A unique identifier for each certificate.", "minimum": 1, "readOnly": true, "type": "integer" }, "certificateRequest": { "description": "Value for the certificate signing request (CSR). ASCII, base64-encoded text starting with `-----BEGIN CERTIFICATE REQUEST-----` and ending with `-----END CERTIFICATE REQUEST-----`.", "format": "byte", "type": "string" }, "createdBy": { "description": "Name of the user who created this certificate.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "expiredDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's expiration.", "format": "date-time", "readOnly": true, "type": "string" }, "fingerprint": { "description": "The certificate's hexadecimal fingerprint.", "minLength": 1, "type": "string" }, "issuedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's issue.", "format": "date-time", "readOnly": true, "type": "string" }, "modifiedBy": { "description": "Name of the user who most recently modified this certificate. If there haven't been any modifications, the value matches `createdBy`.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this certificate's last modification. If there haven't been any modifications, the value matches `createdDate`.", "format": "date-time", "readOnly": true, "type": "string" }, "status": { "description": "__Read-only__ The certificate's deployment status. Either `CREATING`, `UPDATING`, `PENDING_DOWNLOAD`, `PENDING_DISTRIBUTION`, `PENDING_ACTIVATION`, `ACTIVATING`, `ACTIVATED`, `DEACTIVATING`, `DEACTIVATED`, `EXPIRED` or `INCOMPLETE`.", "enum": [ "CREATING", "UPDATING", "PENDING_DOWNLOAD", "PENDING_DISTRIBUTION", "PENDING_ACTIVATION", "ACTIVATING", "ACTIVATED", "DEACTIVATING", "DEACTIVATED", "EXPIRED", "INCOMPLETE" ], "readOnly": true, "type": "string" } }, "required": [ "certificate", "caMode" ], "type": "object", "x-akamai": { "file-path": "schemas/certificate.yaml" } }, "certificates": { "description": "TLS certificates.", "items": { "additionalProperties": false, "description": "Contains data about a TLS certificate.", "properties": { "caMode": { "description": "Mode of the certificate, either `CUSTOMER` or `AKAMAI`.", "enum": [ "CUSTOMER", "AKAMAI" ], "type": "string" }, "certificate": { "description": "Value of the certificate in PEM format. ASCII, base64-encoded text starting with `-----BEGIN CERTIFICATE-----` and ending with `-----END CERTIFICATE-----`.", "type": "string" }, "certificateId": { "description": "__Read-only__ A unique identifier for each certificate.", "minimum": 1, "readOnly": true, "type": "integer" }, "certificateRequest": { "description": "Value for the certificate signing request (CSR). ASCII, base64-encoded text starting with `-----BEGIN CERTIFICATE REQUEST-----` and ending with `-----END CERTIFICATE REQUEST-----`.", "format": "byte", "type": "string" }, "createdBy": { "description": "Name of the user who created this certificate.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "expiredDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's expiration.", "format": "date-time", "readOnly": true, "type": "string" }, "fingerprint": { "description": "The certificate's hexadecimal fingerprint.", "minLength": 1, "type": "string" }, "issuedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's issue.", "format": "date-time", "readOnly": true, "type": "string" }, "modifiedBy": { "description": "Name of the user who most recently modified this certificate. If there haven't been any modifications, the value matches `createdBy`.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this certificate's last modification. If there haven't been any modifications, the value matches `createdDate`.", "format": "date-time", "readOnly": true, "type": "string" }, "status": { "description": "__Read-only__ The certificate's deployment status. Either `CREATING`, `UPDATING`, `PENDING_DOWNLOAD`, `PENDING_DISTRIBUTION`, `PENDING_ACTIVATION`, `ACTIVATING`, `ACTIVATED`, `DEACTIVATING`, `DEACTIVATED`, `EXPIRED` or `INCOMPLETE`.", "enum": [ "CREATING", "UPDATING", "PENDING_DOWNLOAD", "PENDING_DISTRIBUTION", "PENDING_ACTIVATION", "ACTIVATING", "ACTIVATED", "DEACTIVATING", "DEACTIVATED", "EXPIRED", "INCOMPLETE" ], "readOnly": true, "type": "string" } }, "required": [ "certificate", "caMode" ], "type": "object", "x-akamai": { "file-path": "schemas/certificate.yaml" } }, "minItems": 1, "type": "array", "x-akamai": { "file-path": "schemas/certificates.yaml" } }, "problem": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } }, "problem-401": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } }, "problem-nested": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } } } }, "externalDocs": { "description": "See documentation for Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference" }, "info": { "description": "A programmatic interface to manage policy settings to protect\nagainst enterprise security and acceptable user policy related events.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: Secure Internet Access Enterprise Configuration API", "version": "v3" }, "openapi": "3.0.0", "paths": { "/akamai-lists": { "get": { "description": "Returns all available Akamai built-in lists.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-akamai-lists" }, "operationId": "get-akamai-lists", "parameters": [ { "description": "Indicates if the result set includes non-configurable resources, `false` by default.", "in": "query", "name": "includeNonConfigurable", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/include-non-configurable.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "allowedForDnsPolicy": true, "createdBy": "jperez", "createdDate": "2016-06-30T08:30:14.391+0000", "description": "Malware", "id": 1, "name": "Malware", "securityCategoryId": 1, "securityCategoryInfo": { "id": 1, "name": "Malware" } }, { "allowedForDnsPolicy": true, "createdBy": "mrossi", "createdDate": "2016-06-30T08:30:14.393+0000", "description": "Phishing", "id": 2, "name": "Phishing", "securityCategoryId": 2, "securityCategoryInfo": { "id": 2, "name": "Phishing" } }, { "allowedForDnsPolicy": true, "createdBy": "alfulani", "createdDate": "2016-06-30T08:30:14.395+0000", "description": "C&C", "id": 3, "name": "C&C", "securityCategoryId": 3, "securityCategoryInfo": { "id": 3, "name": "C&C" } }, { "allowedForDnsPolicy": true, "createdBy": "jperez", "createdDate": "2018-05-16T13:06:12.395+0000", "description": "DNS Exfiltration", "id": 4, "name": "DNS Exfiltration", "securityCategoryId": 5, "securityCategoryInfo": { "id": 5, "name": "DNS Exfiltration" } }, { "allowedForDnsPolicy": false, "createdBy": "tyamada", "createdDate": "2018-03-05T09:52:29.339+0000", "description": "Risky domains", "id": 8, "name": "Risky domains", "securityCategoryId": 6, "securityCategoryInfo": { "id": 6, "name": "Risky domains" } }, { "allowedForDnsPolicy": false, "createdBy": "jperez", "createdDate": "2018-03-05T09:52:29.345+0000", "description": "File sharing", "id": 9, "name": "File sharing", "securityCategoryId": 7, "securityCategoryInfo": { "id": 7, "name": "File sharing" } } ], "schema": { "description": "Security list details.", "items": { "additionalProperties": false, "properties": { "allowedForDnsPolicy": { "description": "Lists allowed for DNS policy.", "type": "boolean" }, "createdBy": { "description": "Author of the list.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp of the list creation.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "A description for the security list.", "minLength": 1, "type": "string" }, "id": { "description": "A unique identifier for each security list. Use this value for `listId` in subsequent operations.", "minimum": 1, "type": "integer" }, "listType": { "description": "The list type. See [List types](https://techdocs.akamai.com/etp-config/reference/list-types) for details on each value.", "enum": [ "AKAMAI", "TOP_LEVEL_DOMAIN", "WHITELIST", "FILEHASHLIST", "FILEHASH_BLOCK", "DOMAIN_IP_LIST", "URL_BLOCK", "URL_BYPASS" ], "type": "string" }, "name": { "description": "The name of the list.", "minLength": 1, "type": "string" }, "securityCategoryId": { "description": "A unique identifier for the security category.", "minimum": 1, "type": "integer" }, "securityCategoryInfo": { "additionalProperties": false, "description": "Contains data about the security category.", "properties": { "id": { "description": "A unique identifier for the security category.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the security category.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "name", "description", "allowedForDnsPolicy", "createdBy", "createdDate", "id", "securityCategoryId", "securityCategoryInfo" ], "type": "object" }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/akamai-security-lists.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List all Akamai built-in security lists", "tags": [ "Akamai built-in security lists" ] }, "x-akamai": { "file-path": "paths/akamai-lists.yaml", "path-info": "/akamai-lists" } }, "/configs/all": { "get": { "description": "Returns configuration IDs. Use this value for a `configId` parameter in subsequent operations.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-configs" }, "operationId": "get-configs", "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": [ { "contractId": "K-0N7RAK71", "firstTimeWizardStep": 1, "groupId": 12345, "id": 1100, "name": "Config for 3-NJPSW", "onboarded": true } ], "schema": { "description": "Provides SIA configuration details.", "items": { "additionalProperties": false, "description": "Provides SIA configuration details.", "properties": { "contractId": { "description": "The unique identifier for the contract.", "minLength": 1, "type": "string" }, "firstTimeWizardStep": { "description": "Indicates the wizard step value.", "minimum": 0, "type": "integer" }, "groupId": { "description": "Unique identifier of the group containing contract.", "minimum": 1, "type": "integer" }, "id": { "description": "Unique identifier of the contract.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of contract/customer.", "minLength": 1, "type": "string" }, "onboarded": { "description": "Onboards the contract.", "type": "boolean" } }, "required": [ "name", "contractId", "firstTimeWizardStep", "groupId", "id", "onboarded" ], "type": "object", "x-akamai": { "file-path": "schemas/etp-configuration.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/etp-configuration-container.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } } }, "summary": "List configurations", "tags": [ "Configurations" ] }, "x-akamai": { "file-path": "paths/all.yaml", "path-info": "/configs/all" } }, "/configs/onboard": { "post": { "description": "Onboards the specified contract.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-config" }, "operationId": "post-config", "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": { "contractId": "K-0N7RAK7", "onboarded": true }, "schema": { "additionalProperties": false, "description": "Onboard request details.", "properties": { "accountId": { "description": "Identifies the account for the contract to onboard.", "minLength": 1, "type": "string" }, "contractId": { "description": "The contract ID to onboard.", "minLength": 1, "type": "string" }, "contractTypeId": { "description": "The type ID for the contract to onboard.", "minLength": 1, "type": "string" }, "getFirstTimeWizardStep": { "description": "First Time Wizard step indicating the progress of setup.", "minimum": 0, "type": "integer" }, "groupId": { "description": "__Read-only__ Unique identifier of the group the contract belongs to.", "minimum": 1, "readOnly": true, "type": "integer" }, "id": { "description": "__Read-only__ Unique identifier for the onboard object.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the customer for the contract.", "minLength": 1, "type": "string" }, "onboarded": { "description": "Indicates the onboarding status.", "type": "boolean" } }, "required": [ "contractId", "onboarded" ], "type": "object", "x-akamai": { "file-path": "schemas/onboard-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "406": { "content": { "application/problem+json": { "example": { "detail": "Contract already onboarded. Code-090209", "instance": "3eea5330-087f-4e1c-8db5-029fd8e4cd01", "status": 406, "title": "Not acceptable", "type": "https://problems.omni.akamaiapis.net/http/not-acceptable" }, "schema": { "additionalProperties": true, "description": "Onboard response for an onboarded contract.", "properties": { "detail": { "description": "The error message in detail.", "minLength": 1, "type": "string" }, "instance": { "description": "Instance ID where the error occurred.", "minLength": 1, "type": "string" }, "status": { "description": "HTTP status code.", "minimum": 0, "type": "integer" }, "type": { "description": "The SIA error type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/onboard-response.yaml" } } } }, "description": "[Resource already onboarded](https://techdocs.akamai.com/etp-config/reference/406).", "x-akamai": { "file-path": "errors/already-onboarded-406.yaml" } } }, "summary": "Onboard a contract", "tags": [ "Configurations" ] }, "x-akamai": { "file-path": "paths/onboard.yaml", "path-info": "/configs/onboard" } }, "/configs/{configId}/acknowledgment": { "post": { "description": "Create an acknowledgment number for the configuration.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-config-acknowledgment" }, "operationId": "post-config-acknowledgment", "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": { "key": "SIA 1.1" }, "schema": { "additionalProperties": false, "description": "Configuration acknowledgment data.", "properties": { "key": { "description": "The acknowledgment number for SIA configuration.", "minLength": 1, "type": "string" } }, "required": [ "key" ], "type": "object", "x-akamai": { "file-path": "schemas/acknowledgment.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Create an acknowledgment", "tags": [ "Acknowledgments" ] }, "get": { "description": "Returns SIA keys.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-config-acknowledgment" }, "operationId": "get-config-acknowledgment", "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": [ { "key": "SIA 1.1" } ], "schema": { "description": "Lists the configuration's acknowledgments.", "items": { "additionalProperties": false, "description": "Configuration acknowledgment data.", "properties": { "key": { "description": "The acknowledgment number for SIA configuration.", "minLength": 1, "type": "string" } }, "required": [ "key" ], "type": "object", "x-akamai": { "file-path": "schemas/acknowledgment.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/acknowledgment-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get an acknowledgment", "tags": [ "Acknowledgments" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/acknowledgment.yaml", "path-info": "/configs/{configId}/acknowledgment" } }, "/configs/{configId}/akamai-sinkholes": { "post": { "description": "Creates a security connector.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-security-connector" }, "operationId": "post-security-connector", "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": { "aliases": [ "abcd.com" ], "description": "Akamai Sinkhole", "ipv4Addrs": [ "192.0.2.223" ], "ipv6Addrs": [ "2001:db8:9142:c617:86dc:7481:d33c:37aa" ], "name": "praveenconnector", "policies": [ { "id": 2250, "name": "NAmer_policy" } ] }, "schema": { "additionalProperties": false, "description": "Sinkhole details.", "properties": { "activationCode": { "description": "Activation code for the security connector.", "minLength": 1, "type": "string" }, "activationCodeExpiry": { "description": "Time in seconds the `activationCode` is valid.", "minimum": 0, "type": "integer" }, "aliases": { "description": "Aliased name of the security connector.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "createdBy": { "description": "The user who created the security connector.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ Date of security connector creation.", "format": "date-time", "readOnly": true, "type": "string" }, "deleted": { "description": "Deletes the security connector.", "type": "boolean" }, "description": { "description": "The description of the security connector.", "minLength": 1, "type": "string" }, "id": { "description": "A unique identifier for each security connector.", "minimum": 1, "type": "integer" }, "ipv4Addrs": { "description": "IP address in IPv4 format.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "ipv6Addrs": { "description": "IP address in IPv6 format.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "lastCommunication": { "description": "Number of seconds since last communication with the security connector occurred.", "minimum": 0, "type": "integer" }, "modifiedBy": { "description": "User that modified the security connector.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the security connector's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the security connector.", "minLength": 1, "type": "string" }, "policies": { "description": "The security connector's policy details.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier of the policy.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "status": { "additionalProperties": false, "description": "Status info of the security connector.", "properties": { "availableSoftwareVersion": { "description": "The software version of the security connector.", "minLength": 1, "type": "string" }, "connectionStatus": { "description": "Connection status of the security connector, either `DISCONNECTED` or `CONNECTED`.", "enum": [ "DISCONNECTED", "CONNECTED" ], "minLength": 1, "type": "string" }, "status": { "description": "The activation status of the security connector, either `ACTIVE`, `INACTIVE`, or `ACTIVATION_IN_PROGRESS`.", "enum": [ "ACTIVE", "INACTIVE", "ACTIVATION_IN_PROGRESS" ], "type": "string" } }, "required": [ "connectionStatus", "status" ], "type": "object" }, "supportedUntil": { "description": "Number of seconds remaining in a security connector's support period.", "minimum": 0, "type": "integer" }, "uuid": { "description": "Unique identifier for the security connector.", "minLength": 1, "type": "string" }, "version": { "description": "The version number of the security connector.", "minLength": 1, "type": "string" } }, "required": [ "name", "aliases", "ipv4Addrs", "policies" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "aliases": [ "abcd.com" ], "createdBy": "alfulani", "createdDate": "2017-11-30T06:25:21.315+0000", "deleted": false, "description": "Akamai Sinkhole", "id": 2140, "ipv4Addrs": [ "192.0.2.112" ], "ipv6Addrs": [ "2001:db8:65af:243e:1446:5bc0:7a93:fdd" ], "lastCommunication": 1512109949000, "modifiedBy": "hgildong", "modifiedDate": "2017-11-30T06:25:21.315+0000", "name": "AKAconnector", "policies": [ { "id": 2250, "name": "APAC Policy" } ], "status": { "availableSoftwareVersion": "2.5.0", "connectionStatus": "DISCONNECTED", "status": "ACTIVE" }, "supportedUntil": 1572998400000, "uuid": "4e627653-086e-454f-9821-0dbdd8500035", "version": "192.0.2.241" }, "schema": { "additionalProperties": false, "description": "Sinkhole details.", "properties": { "activationCode": { "description": "Activation code for the security connector.", "minLength": 1, "type": "string" }, "activationCodeExpiry": { "description": "Time in seconds the `activationCode` is valid.", "minimum": 0, "type": "integer" }, "aliases": { "description": "Aliased name of the security connector.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "createdBy": { "description": "The user who created the security connector.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ Date of security connector creation.", "format": "date-time", "readOnly": true, "type": "string" }, "deleted": { "description": "Deletes the security connector.", "type": "boolean" }, "description": { "description": "The description of the security connector.", "minLength": 1, "type": "string" }, "id": { "description": "A unique identifier for each security connector.", "minimum": 1, "type": "integer" }, "ipv4Addrs": { "description": "IP address in IPv4 format.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "ipv6Addrs": { "description": "IP address in IPv6 format.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "lastCommunication": { "description": "Number of seconds since last communication with the security connector occurred.", "minimum": 0, "type": "integer" }, "modifiedBy": { "description": "User that modified the security connector.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the security connector's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the security connector.", "minLength": 1, "type": "string" }, "policies": { "description": "The security connector's policy details.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier of the policy.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "status": { "additionalProperties": false, "description": "Status info of the security connector.", "properties": { "availableSoftwareVersion": { "description": "The software version of the security connector.", "minLength": 1, "type": "string" }, "connectionStatus": { "description": "Connection status of the security connector, either `DISCONNECTED` or `CONNECTED`.", "enum": [ "DISCONNECTED", "CONNECTED" ], "minLength": 1, "type": "string" }, "status": { "description": "The activation status of the security connector, either `ACTIVE`, `INACTIVE`, or `ACTIVATION_IN_PROGRESS`.", "enum": [ "ACTIVE", "INACTIVE", "ACTIVATION_IN_PROGRESS" ], "type": "string" } }, "required": [ "connectionStatus", "status" ], "type": "object" }, "supportedUntil": { "description": "Number of seconds remaining in a security connector's support period.", "minimum": 0, "type": "integer" }, "uuid": { "description": "Unique identifier for the security connector.", "minLength": 1, "type": "string" }, "version": { "description": "The version number of the security connector.", "minLength": 1, "type": "string" } }, "required": [ "name", "aliases", "ipv4Addrs", "policies" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole.yaml" } } } }, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Create a security connector", "tags": [ "Security connectors" ] }, "get": { "description": "Returns security connectors.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-security-connectors" }, "operationId": "get-security-connectors", "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": [ { "aliases": [ "abcd.com" ], "createdBy": "alfulani", "createdDate": "2017-11-30T09:59:19.967+0000", "deleted": false, "description": "Akamai Sinkhole", "id": 2147, "ipv4Addrs": [ "192.0.2.58" ], "ipv6Addrs": [ "2001:db8:ecab:84eb:e2af:5bc0:1a52:3d81" ], "lastCommunication": 1516787738000, "modifiedBy": "szhang", "modifiedDate": "2017-11-30T09:59:19.967+0000", "name": "SecurityConnforBLR", "policies": [ { "id": 2250, "name": "NAmer Policy" } ], "status": { "availableSoftwareVersion": "2.5.0", "connectionStatus": "DISCONNECTED", "status": "ACTIVE" }, "supportedUntil": 1572998400000, "uuid": "2c582ae6-2552-423b-a84d-a36a9fd42ef6", "version": "192.0.2.207" }, { "aliases": [ "abcd.com" ], "createdBy": "jkowalski", "createdDate": "2017-11-13T20:07:18.585+0000", "deleted": false, "description": "Akamai Sinkhole", "id": 1760, "ipv4Addrs": [ "192.0.2.73" ], "ipv6Addrs": [ "2001:db8:bb6b:1ac3:56d6:4957:f1b5:6177" ], "lastCommunication": 1510603585000, "modifiedBy": "jperez", "modifiedDate": "2017-11-13T20:07:18.585+0000", "name": "ESC", "policies": [ { "id": 2250, "name": "EMEA Policy" } ], "status": { "availableSoftwareVersion": "2.5.0", "connectionStatus": "DISCONNECTED", "status": "ACTIVE" }, "supportedUntil": 1572998400000, "uuid": "2f90515f-44f2-432f-9b87-0cbfba6b60aa", "version": "192.0.2.88" }, { "aliases": [ "abcd.com" ], "createdBy": "adevi", "createdDate": "2020-07-15T17:26:22.742+0000", "deleted": false, "id": 29404, "ipv4Addrs": [ "192.0.2.184" ], "ipv6Addrs": [ "2019:D30::88/124", "2021:D32::88/124" ], "modifiedBy": "szhang", "modifiedDate": "2020-07-15T17:26:22.743+0000", "name": "SC-1", "policies": [ { "id": 2250, "name": "NAmer Policy" } ], "status": { "connectionStatus": "DISCONNECTED", "status": "ACTIVATION_IN_PROGRESS" }, "supportedUntil": 1622972585000, "uuid": "deec885e-9240-4719-ab3d-d744ce6d9aad", "version": "SC-2.6.8" } ], "schema": { "description": "Security connectors.", "items": { "additionalProperties": false, "description": "Sinkhole details.", "properties": { "activationCode": { "description": "Activation code for the security connector.", "minLength": 1, "type": "string" }, "activationCodeExpiry": { "description": "Time in seconds the `activationCode` is valid.", "minimum": 0, "type": "integer" }, "aliases": { "description": "Aliased name of the security connector.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "createdBy": { "description": "The user who created the security connector.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ Date of security connector creation.", "format": "date-time", "readOnly": true, "type": "string" }, "deleted": { "description": "Deletes the security connector.", "type": "boolean" }, "description": { "description": "The description of the security connector.", "minLength": 1, "type": "string" }, "id": { "description": "A unique identifier for each security connector.", "minimum": 1, "type": "integer" }, "ipv4Addrs": { "description": "IP address in IPv4 format.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "ipv6Addrs": { "description": "IP address in IPv6 format.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "lastCommunication": { "description": "Number of seconds since last communication with the security connector occurred.", "minimum": 0, "type": "integer" }, "modifiedBy": { "description": "User that modified the security connector.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the security connector's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the security connector.", "minLength": 1, "type": "string" }, "policies": { "description": "The security connector's policy details.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier of the policy.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "status": { "additionalProperties": false, "description": "Status info of the security connector.", "properties": { "availableSoftwareVersion": { "description": "The software version of the security connector.", "minLength": 1, "type": "string" }, "connectionStatus": { "description": "Connection status of the security connector, either `DISCONNECTED` or `CONNECTED`.", "enum": [ "DISCONNECTED", "CONNECTED" ], "minLength": 1, "type": "string" }, "status": { "description": "The activation status of the security connector, either `ACTIVE`, `INACTIVE`, or `ACTIVATION_IN_PROGRESS`.", "enum": [ "ACTIVE", "INACTIVE", "ACTIVATION_IN_PROGRESS" ], "type": "string" } }, "required": [ "connectionStatus", "status" ], "type": "object" }, "supportedUntil": { "description": "Number of seconds remaining in a security connector's support period.", "minimum": 0, "type": "integer" }, "uuid": { "description": "Unique identifier for the security connector.", "minLength": 1, "type": "string" }, "version": { "description": "The version number of the security connector.", "minLength": 1, "type": "string" } }, "required": [ "name", "aliases", "ipv4Addrs", "policies" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/sinkholes-list.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List security connectors", "tags": [ "Security connectors" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/akamai-sinkholes.yaml", "path-info": "/configs/{configId}/akamai-sinkholes" } }, "/configs/{configId}/akamai-sinkholes/latest-version": { "get": { "description": "Provides the current version of the security connectors.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-security-connectors-latest-version" }, "operationId": "get-security-connectors-latest-version", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "entitlementCode": "4f5715cd-4f96-4748-9d2f-fa9d9d6b9838", "packageLocation": "https://dnsclient.sia.akamai.com/vm/PLEASE READ - Beta Expiration.txt?token=st=1597088278~exp=1597091878~acl=%2F%2A~hmac=801c68d7a08c7ab36cf5d98cf62aad143de62323feb2568352e91d4028bb9891", "version": "192.0.2.129" }, "schema": { "additionalProperties": false, "description": "Security connector version details.", "properties": { "entitlementCode": { "description": "The entitlement code in encoded format.", "minLength": 1, "type": "string" }, "packageLocation": { "description": "The URL to download the security connector package from Akamai.", "type": "string" }, "type": { "description": "Name of the security connector's vendor.", "minLength": 1, "type": "string" }, "version": { "description": "The security connector version.", "minLength": 1, "type": "string" } }, "required": [ "version", "entitlementCode", "packageLocation" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-current-version.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List the current security connector versions", "tags": [ "Security connectors" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/latest-version.yaml", "path-info": "/configs/{configId}/akamai-sinkholes/latest-version" } }, "/configs/{configId}/akamai-sinkholes/sc-latest-versions": { "get": { "description": "Provides the latest available version for the security connector.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-security-connector-latest-versions" }, "operationId": "get-security-connector-latest-versions", "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": [ { "entitlementCode": "4f5715cd-4f96-4748-9d2f-fa9d9d6b9838", "packageLocation": "https://dnsclient.sia.akamai.com/security-connector/vm/la/akamai-security-connector.zip?token=st=1596837469~exp=1596841069~acl=%2F%2A~hmac=7f1b4ab6d659cdeef88a1245a5b532aa1278757c7f655bdd34238dc562e001d3", "type": "MICROSOFT", "version": "SC-2.6.8" }, { "entitlementCode": "4f5715cd-4f96-4748-9d2f-fa9d9d6b9838", "packageLocation": "https://dnsclient.sia.akamai.com/security-connector/vm/la/akamai-security-connector.ova?token=st=1596837470~exp=1596841070~acl=%2F%2A~hmac=40d9a9076365e12072dab29aed5a90d648cdf9d1a1602f1557fea0a32936e23a", "type": "VMWARE", "version": "SC-2.6.8" } ], "schema": { "description": "The latest available version of the security connector.", "items": { "additionalProperties": false, "description": "Security connector version details.", "properties": { "entitlementCode": { "description": "The entitlement code in encoded format.", "minLength": 1, "type": "string" }, "packageLocation": { "description": "Location of security connector package in Akamai.", "minLength": 1, "type": "string" }, "type": { "description": "Name of security connector vendor.", "minLength": 1, "type": "string" }, "version": { "description": "The security connector version.", "minLength": 1, "type": "string" } }, "required": [ "version", "packageLocation", "entitlementCode" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-version.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/sinkhole-latest-version.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get the security connector's latest available version", "tags": [ "Security connectors" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/sc-latest-versions.yaml", "path-info": "/configs/{configId}/akamai-sinkholes/sc-latest-versions" } }, "/configs/{configId}/akamai-sinkholes/{sinkholeId}": { "get": { "description": "Returns the details of a specific security connector.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-security-connector" }, "operationId": "get-security-connector", "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": { "aliases": [ "abcd.com" ], "createdBy": "alfulani", "createdDate": "2017-11-30T06:25:21.315+0000", "deleted": false, "description": "Akamai Sinkhole", "id": 2140, "ipv4Addrs": [ "192.0.2.112" ], "ipv6Addrs": [ "2001:db8:65af:243e:1446:5bc0:7a93:fdd" ], "lastCommunication": 1512109949000, "modifiedBy": "hgildong", "modifiedDate": "2017-11-30T06:25:21.315+0000", "name": "AKAconnector", "policies": [ { "id": 2250, "name": "APAC Policy" } ], "status": { "availableSoftwareVersion": "2.5.0", "connectionStatus": "DISCONNECTED", "status": "ACTIVE" }, "supportedUntil": 1572998400000, "uuid": "4e627653-086e-454f-9821-0dbdd8500035", "version": "192.0.2.241" }, "schema": { "additionalProperties": false, "description": "Sinkhole details.", "properties": { "activationCode": { "description": "Activation code for the security connector.", "minLength": 1, "type": "string" }, "activationCodeExpiry": { "description": "Time in seconds the `activationCode` is valid.", "minimum": 0, "type": "integer" }, "aliases": { "description": "Aliased name of the security connector.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "createdBy": { "description": "The user who created the security connector.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ Date of security connector creation.", "format": "date-time", "readOnly": true, "type": "string" }, "deleted": { "description": "Deletes the security connector.", "type": "boolean" }, "description": { "description": "The description of the security connector.", "minLength": 1, "type": "string" }, "id": { "description": "A unique identifier for each security connector.", "minimum": 1, "type": "integer" }, "ipv4Addrs": { "description": "IP address in IPv4 format.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "ipv6Addrs": { "description": "IP address in IPv6 format.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "lastCommunication": { "description": "Number of seconds since last communication with the security connector occurred.", "minimum": 0, "type": "integer" }, "modifiedBy": { "description": "User that modified the security connector.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the security connector's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the security connector.", "minLength": 1, "type": "string" }, "policies": { "description": "The security connector's policy details.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique identifier of the policy.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "status": { "additionalProperties": false, "description": "Status info of the security connector.", "properties": { "availableSoftwareVersion": { "description": "The software version of the security connector.", "minLength": 1, "type": "string" }, "connectionStatus": { "description": "Connection status of the security connector, either `DISCONNECTED` or `CONNECTED`.", "enum": [ "DISCONNECTED", "CONNECTED" ], "minLength": 1, "type": "string" }, "status": { "description": "The activation status of the security connector, either `ACTIVE`, `INACTIVE`, or `ACTIVATION_IN_PROGRESS`.", "enum": [ "ACTIVE", "INACTIVE", "ACTIVATION_IN_PROGRESS" ], "type": "string" } }, "required": [ "connectionStatus", "status" ], "type": "object" }, "supportedUntil": { "description": "Number of seconds remaining in a security connector's support period.", "minimum": 0, "type": "integer" }, "uuid": { "description": "Unique identifier for the security connector.", "minLength": 1, "type": "string" }, "version": { "description": "The version number of the security connector.", "minLength": 1, "type": "string" } }, "required": [ "name", "aliases", "ipv4Addrs", "policies" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get a security connector", "tags": [ "Security connectors" ] }, "delete": { "description": "Deletes the specified security connector. Add an `If-Match` header to prevent deleting any data another client has modified since you last accessed it.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/delete-security-connector" }, "operationId": "delete-security-connector", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Delete a security connector", "tags": [ "Security connectors" ] }, "parameters": [ { "description": "A unique identifier for the security connector.", "in": "path", "name": "sinkholeId", "required": true, "schema": { "example": 2140, "type": "integer" }, "x-akamai": { "file-path": "parameters/sinkhole-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/sinkhole.yaml", "path-info": "/configs/{configId}/akamai-sinkholes/{sinkholeId}" } }, "/configs/{configId}/akamai-sinkholes/{sinkholeId}/op/change-local-password": { "post": { "description": "Changes the local password for the specified security connector.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-security-connector-change-local-password" }, "operationId": "post-security-connector-change-local-password", "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": { "newPassword": "abc123" }, "schema": { "additionalProperties": false, "description": "Changes the local password for the security connector.", "properties": { "newPassword": { "description": "Plain password meeting the password criteria.", "minLength": 1, "type": "string" } }, "required": [ "newPassword" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-change-pwd.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Change a local security connector password", "tags": [ "Security connectors" ] }, "parameters": [ { "description": "A unique identifier for the security connector.", "in": "path", "name": "sinkholeId", "required": true, "schema": { "example": 2140, "type": "integer" }, "x-akamai": { "file-path": "parameters/sinkhole-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/change-local-password.yaml", "path-info": "/configs/{configId}/akamai-sinkholes/{sinkholeId}/op/change-local-password" } }, "/configs/{configId}/akamai-sinkholes/{sinkholeId}/op/generate-activation-code": { "post": { "description": "Generates the activation code for a security connector.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-security-connector-generate-activation-code" }, "operationId": "post-security-connector-generate-activation-code", "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": { "activationCode": "4X8G4K2Z", "activationCodeExpiry": 1597671355820, "akamaiSinkholeId": 29404, "configId": 1100, "entitlementCode": "4f5715cd-4f96-4748-9d2f-fa9d9d6b9838", "serialNumber": "deec885e-9240-4719-ab3d-d744ce6d9aad" }, "schema": { "additionalProperties": false, "description": "Provides the activation code details.", "properties": { "activationCode": { "description": "Activation code generated for the security connector.", "minLength": 1, "type": "string" }, "activationCodeExpiry": { "description": "A timestamp indicating when the activation code becomes invalid.", "minimum": 0, "type": "integer" }, "akamaiSinkholeId": { "description": "The unique identifier of the security connector.", "minimum": 1, "type": "integer" }, "configId": { "description": "The unique identifier of the configuration.", "minimum": 1, "type": "integer" }, "entitlementCode": { "description": "The entitlement code for the security connector.", "minLength": 1, "type": "string" }, "serialNumber": { "description": "The unique serial number for the security connector.", "minLength": 1, "type": "string" } }, "required": [ "activationCode", "activationCodeExpiry", "akamaiSinkholeId", "configId", "entitlementCode", "serialNumber" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-code-generation.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Generate an activation code for a security connector", "tags": [ "Security connectors" ] }, "parameters": [ { "description": "A unique identifier for the security connector.", "in": "path", "name": "sinkholeId", "required": true, "schema": { "example": 2140, "type": "integer" }, "x-akamai": { "file-path": "parameters/sinkhole-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/generate-activation-code.yaml", "path-info": "/configs/{configId}/akamai-sinkholes/{sinkholeId}/op/generate-activation-code" } }, "/configs/{configId}/akamai-sinkholes/{sinkholeId}/op/upgrade": { "post": { "description": "Upgrades software of a specific security connector.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-security-connector-upgrade" }, "operationId": "post-security-connector-upgrade", "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": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Upgrade a security connector", "tags": [ "Security connectors" ] }, "parameters": [ { "description": "A unique identifier for the security connector.", "in": "path", "name": "sinkholeId", "required": true, "schema": { "example": 2140, "type": "integer" }, "x-akamai": { "file-path": "parameters/sinkhole-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/upgrade.yaml", "path-info": "/configs/{configId}/akamai-sinkholes/{sinkholeId}/op/upgrade" } }, "/configs/{configId}/akamai-sinkholes/{sinkholeId}/policy-assignment": { "put": { "description": "Modifies details of the current security connector.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-security-connector" }, "operationId": "put-security-connector", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "aupResponseId": 1234, "deleteSinkhole": false, "newId": 29404 }, "schema": { "additionalProperties": false, "description": "Replaces the current security connector, or optionally deletes the current security connector.", "properties": { "aupResponseId": { "description": "__Read-only__ The unique identifier of the new custom response.", "minimum": 1, "readOnly": true, "type": "integer" }, "deleteSinkhole": { "description": "Deletes the current security connector.", "type": "boolean" }, "newId": { "description": "The unique identifier for the new security connector.", "minimum": 1, "type": "integer" } }, "required": [ "newId", "deleteSinkhole" ], "type": "object", "x-akamai": { "file-path": "schemas/sinkhole-policy-assignment.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Update a security connector", "tags": [ "Security connectors" ] }, "parameters": [ { "description": "A unique identifier for the security connector.", "in": "path", "name": "sinkholeId", "required": true, "schema": { "example": 2140, "type": "integer" }, "x-akamai": { "file-path": "parameters/sinkhole-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/policy-assignment.yaml", "path-info": "/configs/{configId}/akamai-sinkholes/{sinkholeId}/policy-assignment" } }, "/configs/{configId}/clear-dns-cache": { "post": { "description": "Clears the DNS cache for the specified domain.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-dns-cache" }, "operationId": "post-dns-cache", "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": [ "domain.com" ], "schema": { "description": "Array of lists to clear cached DNS domains.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/clear-dns-cache.yaml" } } } } }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Clear the DNS cache", "tags": [ "DNS cache" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/clear-dns-cache.yaml", "path-info": "/configs/{configId}/clear-dns-cache" } }, "/configs/{configId}/client-configuration": { "get": { "description": "Provides client configuration details.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-client-configuration" }, "operationId": "get-client-configuration", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "clientIdentityReporting": true, "createdDate": "2017-10-02T13:33:30.371+0000", "downgradeEnable": true, "endUserControl": true, "entitlementCode": "07156ca7-ebd0-46c9-a285-e6e87d1ef047", "forwardDnsTraffic": true, "httpProxyOverride": 2, "httpProxyPort": 8080, "modifiedDate": "2020-08-06T23:31:30.477+0000", "securityPatchAutoUpgrade": true, "uninstallEnable": true }, "schema": { "additionalProperties": false, "description": "Lists client configuration properties.", "properties": { "accessLog": { "description": "Enables access logging.", "type": "boolean" }, "clientIdentityReporting": { "description": "Enables client identity reporting.", "type": "boolean" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the report schedule configuration's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "downgradeEnable": { "description": "Enables downgrade.", "type": "boolean" }, "endUserControl": { "description": "Enables end user control.", "type": "boolean" }, "entitlementCode": { "description": "The entitlement code in encoded format.", "minLength": 1, "type": "string" }, "forwardDnsTraffic": { "description": "Enables DNS forwarding.", "type": "boolean" }, "httpProxyOverride": { "description": "The HTTP proxy override units.", "minimum": 0, "type": "integer" }, "httpProxyPort": { "description": "The proxy port of the client.", "minimum": 1, "type": "integer" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the last report schedule modification.", "format": "date-time", "readOnly": true, "type": "string" }, "securityPatchAutoUpgrade": { "description": "Enables security patch auto upgrade.", "type": "boolean" }, "uninstallEnable": { "description": "Enables uninstall.", "type": "boolean" } }, "required": [ "clientIdentityReporting", "createdDate", "downgradeEnable", "endUserControl", "entitlementCode", "forwardDnsTraffic", "httpProxyOverride", "httpProxyPort", "securityPatchAutoUpgrade", "uninstallEnable" ], "type": "object", "x-akamai": { "file-path": "schemas/client-configuration.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get a client configuration", "tags": [ "Client configuration" ] }, "put": { "description": "Updates the client configuration.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-client-configuration" }, "operationId": "put-client-configuration", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "clientIdentityReporting": true, "downgradeEnable": true, "endUserControl": true, "entitlementCode": "07156ca7-ebd0-46c9-a285-e6e87d1ef047", "forwardDnsTraffic": true, "httpProxyOverride": 2, "httpProxyPort": 8080, "securityPatchAutoUpgrade": true, "uninstallEnable": true }, "schema": { "additionalProperties": false, "description": "Lists client config update properties.", "properties": { "clientIdentityReporting": { "description": "Enables client identity reporting.", "type": "boolean" }, "downgradeEnable": { "description": "Enables client downgrade.", "type": "boolean" }, "endUserControl": { "description": "Enables end user control.", "type": "boolean" }, "entitlementCode": { "description": "The entitlement code in encoded format.", "minLength": 1, "type": "string" }, "forwardDnsTraffic": { "description": "Enables DNS traffic forwarding.", "type": "boolean" }, "httpProxyOverride": { "description": "The HTTP proxy override units.", "minimum": 0, "type": "integer" }, "httpProxyPort": { "description": "The proxy port of the client.", "minimum": 1, "type": "integer" }, "securityPatchAutoUpgrade": { "description": "Enables security patch auto upgrade.", "type": "boolean" }, "uninstallEnable": { "description": "Enables uninstall.", "type": "boolean" } }, "required": [ "clientIdentityReporting", "downgradeEnable", "endUserControl", "entitlementCode", "forwardDnsTraffic", "httpProxyOverride", "httpProxyPort", "securityPatchAutoUpgrade", "uninstallEnable" ], "type": "object", "x-akamai": { "file-path": "schemas/client-config-update.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Update a client configuration", "tags": [ "Client configuration" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/client-configuration.yaml", "path-info": "/configs/{configId}/client-configuration" } }, "/configs/{configId}/client-versions": { "get": { "description": "Provides client versions.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-client-versions" }, "operationId": "get-client-versions", "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": [ { "approvalStatus": "PENDING", "autoupgradeEnabled": true, "osId": 61, "osName": "Windows", "releaseDate": "2020-03-14T00:00:00.000+0000", "releaseStatus": "Security Patch", "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429", "supportedUntil": "2021-01-14T00:00:00Z", "unsupported": false, "versionId": 273, "versionName": "3.2.1" }, { "approvalStatus": "PENDING", "autoupgradeEnabled": true, "osId": 61, "osName": "Windows", "releaseDate": "2020-03-14T00:00:00.000+0000", "releaseStatus": "Beta", "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429", "supportedUntil": "2021-01-14T00:00:00Z", "unsupported": false, "versionId": 271, "versionName": "3.2.0" }, { "approvalStatus": "PENDING", "autoupgradeEnabled": true, "osId": 45, "osName": "Mac", "releaseDate": "2020-03-14T00:00:00.000+0000", "releaseStatus": "Beta", "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429", "supportedUntil": "2021-01-14T00:00:00Z", "unsupported": false, "versionId": 272, "versionName": "3.2.0" }, { "approvalStatus": "PENDING", "autoupgradeEnabled": true, "osId": 45, "osName": "Mac", "releaseDate": "2020-03-14T00:00:00.000+0000", "releaseStatus": "Security Patch", "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429", "supportedUntil": "2021-01-14T00:00:00Z", "unsupported": false, "versionId": 270, "versionName": "3.1.5" }, { "approvalStatus": "PENDING", "autoupgradeEnabled": true, "osId": 61, "osName": "Windows", "releaseDate": "2020-03-14T00:00:00.000+0000", "releaseStatus": "Security Patch", "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429", "supportedUntil": "2021-01-14T00:00:00Z", "unsupported": false, "versionId": 269, "versionName": "3.1.3" }, { "approvalStatus": "PENDING", "autoupgradeEnabled": true, "osId": 45, "osName": "Mac", "releaseDate": "2020-03-14T00:00:00.000+0000", "releaseStatus": "Security Patch", "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429", "supportedUntil": "2021-01-14T00:00:00Z", "unsupported": false, "versionId": 267, "versionName": "3.1.2" }, { "approvalStatus": "PENDING", "autoupgradeEnabled": true, "osId": 61, "osName": "Windows", "releaseDate": "2020-03-14T00:00:00.000+0000", "releaseStatus": "Security Patch", "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429", "supportedUntil": "2021-01-14T00:00:00Z", "unsupported": false, "versionId": 268, "versionName": "3.1.2" } ], "schema": { "description": "Lists client version details.", "items": { "additionalProperties": false, "description": "Lists client version detail object parameters.", "properties": { "approvalDate": { "description": "The approval date of version.", "format": "date-time", "type": "string" }, "approvalStatus": { "description": "Identifies the version approval status. Either `PENDING`, `APPROVED_ON_DEMAND`, or `APPROVED_FORCE_UPGRADE`.\n`APPROVED_ON_DEMAND` means the client version can be upgraded on-demand.\n`APPROVED_FORCE_UPGRADE` means the admin has forced an upgrade to this client version.", "enum": [ "PENDING", "APPROVED_ON_DEMAND", "APPROVED_FORCE_UPGRADE" ], "type": "string" }, "autoupgradeEnabled": { "description": "Enables auto upgrade for the version.", "type": "boolean" }, "downloadDate": { "description": "The download date of version.", "format": "date-time", "type": "string" }, "expirationDate": { "description": "The version's expiration date.", "format": "date-time", "type": "string" }, "osId": { "description": "The unique identifier of the OS installed on client version.", "minimum": 1, "type": "integer" }, "osName": { "description": "The name of OS installed on client.", "minLength": 1, "type": "string" }, "packageLocation": { "description": "Location of version package.", "minLength": 0, "type": "string" }, "releaseDate": { "description": "The release date of version.", "format": "date-time", "type": "string" }, "releaseStatus": { "description": "The status of the version release.", "minLength": 1, "type": "string" }, "restrictedVersion": { "description": "Marks the version as restricted.", "type": "boolean" }, "sha256": { "description": "The SHA-256 representation of the version.", "minLength": 1, "type": "string" }, "supportedUntil": { "description": "The date of expiry of the version.", "minLength": 1, "type": "string" }, "trialVersionConfigIds": { "description": "Config IDs using trial versions.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "unsupported": { "description": "Marks the version as unsupported.", "type": "boolean" }, "versionId": { "description": "The unique identifier of the version.", "minimum": 1, "type": "integer" }, "versionName": { "description": "The name of the specified version.", "minLength": 1, "type": "string" } }, "required": [ "versionId", "versionName", "osId", "osName", "sha256", "supportedUntil", "approvalStatus", "autoupgradeEnabled", "unsupported", "releaseDate" ], "type": "object", "x-akamai": { "file-path": "schemas/client-version-details.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/client-versions.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List client versions", "tags": [ "Client versions" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/client-versions.yaml", "path-info": "/configs/{configId}/client-versions" } }, "/configs/{configId}/client-versions/op/rotate-entitlement-code": { "post": { "description": "Rotates global entitlement code.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-rotate-entitlement-code" }, "operationId": "post-rotate-entitlement-code", "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": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Rotate the client version entitlement code", "tags": [ "Client versions" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/rotate-entitlement-code.yaml", "path-info": "/configs/{configId}/client-versions/op/rotate-entitlement-code" } }, "/configs/{configId}/client-versions/{clientVersionId}": { "put": { "description": "Updates the details of the specific client version.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-client-version" }, "operationId": "put-client-version", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "approvalStatus": "PENDING", "autoupgradeEnabled": true, "osId": 61, "osName": "Windows", "releaseDate": "2020-03-14T00:00:00.000+0000", "releaseStatus": "Beta", "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429", "supportedUntil": "2021-01-14T00:00:00Z", "unsupported": false, "versionId": 271, "versionName": "3.2.0" }, "schema": { "additionalProperties": false, "description": "Updates the client-version.", "properties": { "approvalDate": { "description": "__Read-only__ Date of software approval in ISO format.", "format": "date-time", "readOnly": true, "type": "string" }, "approvalStatus": { "description": "__Read-only__ The client version approval status. Either `PENDING`, `APPROVED_ON_DEMAND`, or `APPROVED_FORCE_UPGRADE`. `APPROVED_ON_DEMAND` marks the client version as upgradable on-demand. `APPROVED_FORCE_UPGRADE` marks upgrades to this client version as admin-enforced.", "enum": [ "PENDING", "APPROVED_ON_DEMAND", "APPROVED_FORCE_UPGRADE" ], "readOnly": true, "type": "string" }, "autoupgradeEnabled": { "description": "Enables auto upgrade.", "type": "boolean" }, "downloadDate": { "description": "__Read-only__ ISO 8601 timestamp of the client version download.", "format": "date-time", "readOnly": true, "type": "string" }, "entitlementCode": { "description": "The entitlement code for the client software version.", "minLength": 1, "type": "string" }, "osId": { "description": "__Read-only__ The unique identifier of the OS installed on the client.", "minimum": 1, "readOnly": true, "type": "integer" }, "osName": { "description": "The name of the OS installed on the client.", "minLength": 1, "type": "string" }, "releaseDate": { "description": "__Read-only__ The release date of the version.", "format": "date-time", "readOnly": true, "type": "string" }, "releaseStatus": { "description": "__Read-only__ The version release status.", "minLength": 1, "readOnly": true, "type": "string" }, "sha256": { "description": "The SHA-256 representation of the version.", "minLength": 1, "type": "string" }, "supportedUntil": { "description": "The date of expiry of the version.", "minLength": 1, "type": "string" }, "unsupported": { "description": "Marks the version as unsupported.", "type": "boolean" }, "versionId": { "description": "__Read-only__ The unique identifier of the version.", "minimum": 1, "readOnly": true, "type": "integer" }, "versionName": { "description": "The name of the specified version.", "minLength": 1, "type": "string" } }, "required": [ "approvalStatus", "autoupgradeEnabled", "osId", "osName", "releaseDate", "sha256", "supportedUntil", "unsupported", "versionId", "versionName" ], "type": "object", "x-akamai": { "file-path": "schemas/client-version-update.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Update a client version", "tags": [ "Client versions" ] }, "parameters": [ { "description": "A unique identifier for the client version.", "in": "path", "name": "clientVersionId", "required": true, "schema": { "example": 273, "type": "integer" }, "x-akamai": { "file-path": "parameters/client-version-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/client-version.yaml", "path-info": "/configs/{configId}/client-versions/{clientVersionId}" } }, "/configs/{configId}/client-versions/{clientVersionId}/download": { "get": { "description": "Provides the link to download client version details.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-client-version-download" }, "operationId": "get-client-version-download", "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": { "location": "http://172.25.174.252/content/ETPClient/Windows/EtpClientSetup_3.2.0-1709.dev.a24a7b61.msi?token=st=1597092182~exp=1597095782" }, "schema": { "additionalProperties": false, "description": "Lists client version download properties.", "properties": { "location": { "description": "The URL to download client version details.", "type": "string" } }, "required": [ "location" ], "type": "object", "x-akamai": { "file-path": "schemas/client-version-download.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Download a client version", "tags": [ "Client versions" ] }, "parameters": [ { "description": "A unique identifier for the client version.", "in": "path", "name": "clientVersionId", "required": true, "schema": { "example": 273, "type": "integer" }, "x-akamai": { "file-path": "parameters/client-version-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/download.yaml", "path-info": "/configs/{configId}/client-versions/{clientVersionId}/download" } }, "/configs/{configId}/client/devices": { "get": { "description": "Provides client devices and their details.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-client-devices" }, "operationId": "get-client-devices", "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": [ { "blacklist": false, "id": "211edc0dfb5b4588b50df5f22246fddf", "mac": "02-00-4C-4F-4F-50", "name": "BOS-WP7XS", "originalId": "211edc0d-fb5b-4588-b50d-f5f22246fddf", "registeredTime": 1597350058, "reportedState": "PROTECTED", "reportedTime": 1597684417, "software": "Windows-3.2.0", "user": "jperez" }, { "blacklist": false, "id": "563b533d8c494bbaade7adcbdd6fba5c", "mac": "98-01-A7-BF-AA-31", "name": "MacBook-Air.local", "originalId": "563b533d-8c49-4bba-ade7-adcbdd6fba5c", "registeredTime": 1597460084, "reportedState": "NOT_PROTECTED_OTHER", "reportedTime": 1597684800, "software": "Mac-3.2.0", "user": "asingh" }, { "blacklist": false, "id": "630ace6b4f2641dfb411cd652512cb04", "mac": "38-C9-86-3D-D0-E2", "name": "Lab-Mac-19818179159.local", "originalId": "630ace6b-4f26-41df-b411-cd652512cb04", "registeredTime": 1593227576, "reportedState": "NOT_PROTECTED_OTHER", "reportedTime": 1597684260, "software": "Mac-3.1.1", "user": "hgildong" }, { "blacklist": false, "id": "6bff165ca84b41acb57056a79f49dc3f", "mac": "18-65-90-DA-CB-9B", "name": "Jacks-MacBook-Pro.local", "originalId": "6bff165c-a84b-41ac-b570-56a79f49dc3f", "registeredTime": 1597457344, "reportedState": "NOT_PROTECTED_OTHER", "reportedTime": 1597684799, "software": "Mac-3.2.0", "user": "jkowalski" }, { "blacklist": false, "id": "c0f06dc383774fcb92b41b7fb2f928e5", "mac": "00-0C-29-FD-77-4A", "name": "DESKTOP-6BDEKKS", "originalId": "c0f06dc3-8377-4fcb-92b4-1b7fb2f928e5", "registeredTime": 1597678280, "reportedState": "NOT_PROTECTED_OTHER", "reportedTime": 1597684542, "software": "Windows-3.2.0", "user": "jsmith" }, { "blacklist": false, "id": "dc475a9ec1924b0ba34ea95c0f8dfcad", "mac": "00-0C-29-D5-22-87", "name": "WIN81-ENT-210", "originalId": "dc475a9e-c192-4b0b-a34e-a95c0f8dfcad", "registeredTime": 1592853974, "reportedState": "PROTECTED", "reportedTime": 1597684516, "software": "Windows-3.1.1", "user": "jsmith" } ], "schema": { "description": "Client devices with details.", "items": { "additionalProperties": false, "description": "Details of client device, such as software installed and errors.", "properties": { "blacklist": { "description": "Blocks the device from the network.", "type": "boolean" }, "deviceOwnerId": { "description": "Unique identifier for the owner of the device.", "minLength": 1, "type": "string" }, "id": { "description": "Unique identifier for the client device.", "minLength": 1, "type": "string" }, "mac": { "description": "MAC address of the device.", "minLength": 1, "type": "string" }, "name": { "description": "Name of the client device.", "minLength": 1, "type": "string" }, "originalId": { "description": "Unique identifier for the device by a secondary system.", "minLength": 1, "type": "string" }, "os": { "description": "Name of operating system of the device.", "minLength": 1, "type": "string" }, "osVer": { "description": "Version of the operating system of the device.", "minLength": 1, "type": "string" }, "registeredTime": { "description": "__Read-only__ Timestamp marking when the client device was registered on the network. The value is expressed in epoch seconds.", "minimum": 1, "readOnly": true, "type": "integer" }, "reportedState": { "description": "Last reported status of the device.", "minLength": 1, "type": "string" }, "reportedTime": { "description": "ISO 8601 timestamp marking the last report of the device on network.", "minimum": 1, "type": "integer" }, "software": { "description": "Software installed on the device.", "minLength": 1, "type": "string" }, "user": { "description": "Name of user of the device.", "minLength": 0, "type": "string" } }, "required": [ "name", "id", "registeredTime", "blacklist", "user", "software", "mac", "reportedState", "reportedTime", "originalId" ], "type": "object", "x-akamai": { "file-path": "schemas/client-device-specific.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/client-devices-all.yaml" } } }, "text/csv": { "example": "\ufeff# Client Devices\nname,registered time,blacklisted,software,mac,reported state,reported time\nBOS-WP7XS,2020-08-13T20:20:58,false,Windows-3.2.0,02-00-4C-4F-4F-50,Health check failure,2020-08-17T18:03:42\nMacBook-Air.local,2020-08-15T02:54:44,false,Mac-3.2.0,98-01-A7-BF-AA-31,Other,2020-08-17T18:09:55\nLab-Mac-19818179159.local,2020-06-27T03:12:56,false,Mac-3.1.1,38-C9-86-3D-D0-E2,Other,2020-08-17T18:01:02\nJacks-MacBook-Pro.local,2020-08-15T02:09:04,false,Mac-3.2.0,18-65-90-DA-CB-9B,Other,2020-08-17T18:09:56\nDESKTOP-6BDEKKS,2020-08-17T15:31:20,false,Windows-3.2.0,00-0C-29-FD-77-4A,Other,2020-08-17T18:05:45\nWIN81-ENT-210,2020-06-22T19:26:14,false,Windows-3.1.1,00-0C-29-D5-22-87,Protected,2020-08-17T18:05:19", "schema": { "description": "CSV data.", "minLength": 1, "type": "string", "x-akamai": { "file-path": "schemas/client-devices-csv-data.yaml" } } } }, "description": "The response provides either JSON or CSV data." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List client devices", "tags": [ "Client devices" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/devices.yaml", "path-info": "/configs/{configId}/client/devices" } }, "/configs/{configId}/client/devices/{deviceId}/op/de-activate": { "post": { "description": "Deactivates the specified client device.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-device-de-activate" }, "operationId": "post-device-de-activate", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Deactivate a client device", "tags": [ "Client devices" ] }, "parameters": [ { "description": "A unique identifier for the client device.", "in": "path", "name": "deviceId", "required": true, "schema": { "example": "4e1c63d2-39b0-44b7-9065-5044440d6b69", "type": "string" }, "x-akamai": { "file-path": "parameters/device-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/de-activate.yaml", "path-info": "/configs/{configId}/client/devices/{deviceId}/op/de-activate" } }, "/configs/{configId}/client/devices/{deviceId}/op/re-activate": { "post": { "description": "Re-activates the specified device.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-device-re-activate" }, "operationId": "post-device-re-activate", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Re-activate a client device", "tags": [ "Client devices" ] }, "parameters": [ { "description": "A unique identifier for the client device.", "in": "path", "name": "deviceId", "required": true, "schema": { "example": "4e1c63d2-39b0-44b7-9065-5044440d6b69", "type": "string" }, "x-akamai": { "file-path": "parameters/device-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/re-activate.yaml", "path-info": "/configs/{configId}/client/devices/{deviceId}/op/re-activate" } }, "/configs/{configId}/client/status": { "get": { "description": "Provides details of software installed with device counts. Also specifies errors and device count with errors.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-client-status" }, "operationId": "get-client-status", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "error": [ { "name": "NOT_PROTECTED_OTHER", "total": 4 } ], "installed": [ { "name": "Windows-3.2.0", "total": 2 }, { "name": "Windows-3.1.1", "total": 1 }, { "name": "Mac-3.2.0", "total": 2 }, { "name": "Mac-3.1.1", "total": 1 } ] }, "schema": { "additionalProperties": false, "description": "Details of client devices status.", "properties": { "error": { "description": "The list of errors in software install and devices count.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of error.", "minLength": 1, "type": "string" }, "total": { "description": "The total number of devices with specified error.", "minimum": 0, "type": "integer" } }, "required": [ "name", "total" ], "type": "object" }, "minItems": 0, "type": "array" }, "installed": { "description": "The list of software installed and devices count.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of software.", "minLength": 1, "type": "string" }, "total": { "description": "The total number of devices with installed software.", "minimum": 0, "type": "integer" } }, "required": [ "name", "total" ], "type": "object" }, "minItems": 0, "type": "array" } }, "required": [ "error", "installed" ], "type": "object", "x-akamai": { "file-path": "schemas/client-status.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get client status", "tags": [ "Client devices" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/status.yaml", "path-info": "/configs/{configId}/client/status" } }, "/configs/{configId}/custom-error-page": { "get": { "description": "Gets the custom error page for the configuration.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-custom-error-page" }, "operationId": "get-custom-error-page", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "backgroundTop": { "value": "#D7D7D7" }, "contactMail": { "value": "false" }, "contactPhone": { "value": "false" }, "contactTextColor": { "value": "#7f04ff" }, "contactTicket": { "value": "false" }, "createdDate": "2017-05-11T20:39:30.961+0000", "explanationTextColor": { "value": "#808080" }, "logo": { "value": "url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGAAAAA8CAYAAACZ1L+0AAAgAElEQVR4Xkycd5RkVfXvPzffyrlz7umenBNDziAgiooBAUVFQB8KqGD8gQHMgZ9ZogRBlCQ552GYnHumcw5VXTlX3fBWleut9e7qtfqvut3n7HP23t+wSzivQ7ObAzKiIrBxWzdTMxla29zIksLE8QVESaS9tZmmzi7SsSl01csTT+9gImFSqsJQooANCILA5rDCsaSBZYNh2xQtGxOQRIG1rTpBVaBaMtk9X6Vq2awMyJy/PsjLA0n8TRLLwxGW9rdi5bM0d3Tw75ffp+AoMTFlMrFgoAVFTBNi0yayBJYJtg3tbonek1SO7ysT9oh4e2X8HmgICLT5XexMl1nIVNmytIWDR+dw+CCkCTgkCRuZ0ekC03MmkiLQ0i5RrkKbW2E8apCdq7I8KBHqVBmdLJOXgBmbatkm4hFxWCJlw2K+YmIXwahCR0QkpGkMTJdwKQK9YQebN/QyOD3F/HyB2UyVhaqFXQBhY0ixz90YYmAmi9Oj8d6BNJ/6UBOKCIcPJuq/16xpoaE1gmoKKJLKgy8fY8d4io7mZsrZPDMLMURBwC+LJA2LSm1XAAOB2k/tWeWVKRs2qgRHs7WwwIaAzAUnhnj5eAZNa0S38mxa6Wb46DxnnbeRD2bG2b5njlzUJuOwqZoCxbj13xf+f8/S5QqpnEA6VkFzCfhaJRpaRLobRLodEgfKFpJbxKuKxNMmLh0imogbHUEWGBvJMjFvkXdDc0DEsCA+a1Is2ISDItF5k83LVRZEG68uoM1IzObKLHGoOESV7EKZwWSZjGUTz1ps6NNJxA2yWYuegMxpaxrJlaoMLGShZFEL+1zBYGbRQlgVkO0z1oZ4Ye8iRQNEC9b1Oomny4xGq3QHZTSHwsr+AC0BL7Pzee7/YJ6+tia+ff3V9K7dzLdu/DY79+6ntjW1rbUQ6reitvlLm/yURY1MdJGyaeKRROZrKwSanSKbVnlpbNnAkbEo89EFlkXyjC2UWbvGyzv7M2TyFq3NIqmSzfy0hSDY2P8vqoCmCazZqDE1XsUybTIZm9YVMsvWyCxmLTo0ESUoMB2zWJwxaWlXWBvxMZnLUiyYhIIKkbzGu5NZUpJFT6eMmLOZOlwhWYI1y1RGMgbtAZF0FQKGQCigkluo0CQruGSJiZkSpmmTsK16ZpBdAu0+BVdFZOPydgq5ApPRJMWKSdghIYs2sarBkXEDYUuDYi/v9PGvvXEqpo0sgE8VcckCc3kTvypSMaEzKHHGujCposYLQ1muuuRcPnTxx0hlC0yPDfPo3++hXC7i84VZtqSDLUu7SFfAodrsmC6yJqyQzecYn4wyMDnN8ckFvD6Rm67/Jpdd9SUWJ47ztRu/g2UuEMtFic8YzGdNOhokdLdAYsKiULUxRMiU7fopqoWxrUWlu0VB8usMjmUINgsEOySCAZlk3sSVsYl4JY7nTRILJh/Z3Eq2UGI0lSGLhVmxWSNqbJ8vYgnQ0C8hztlMTRgE3BLtEY2D8RL+oAi1vx+3CCCimwLtjbV8BOl07VSDu5bSFIFo3qBiQMSh09/VxHsHxsnlTCJ+maYGjUq1ymLRIJG3EJZ5Fdvnltg9V64vSBdtFFmgWLbrKaR2lhXAKQmcs8JDb2szOxeVerDWdTWyrdfPCe025VySt48m2HjCVkqCk2R8EaNi8a/3x7jm5BYaI17GYnmyZYvndwzyvQvbKQpOXhspM5CW0SSJ4alZurtb2fHSU8wlTdwNIp1NEkNHjPoJk2WRTMnEMGwUUURXoHOlilqycHa5GZ3KsPRsjSa/Rqji4fholKWWg9lCmSG3jdOwOakjzK5MhsRsGaqgKNCBwKGcRbBVrKcca9GqpwfVLyIIkIqatcyBXa69A4IukXZdpWAbNCgSJdHCKoJu1V+JWhTIe20cVZlo3MAMWAQMkZBbQ9ElYoUCsgj5go1w0+kN9h/ejtbThlkLow2iCFbtTf/fIwqwsUGhu7ebX193DkdHorT5NdwujX0f7GLfRI4lq1cSbgyjiTb5TI5dRyfYfXyOq09fguT1UbFsFrNVdh0cpE0scmaHQvualURNN0PzRQ6OLbJmSYQ7H3oeo3YauySESZtk0cIwQZWEeh3RRPC4BXSXgKaLtDa5yYQNMt4KTid0tgRozTcxuTBBYbxYL9z6aRGEeG3Tq6Q0jUqyTDpVZT5dokkXGM9adHWrONwKR4fzxKZMWpsk9ICAaQtYll2vCS1BkWZdRDMF9LyMYZqURQt3WqMiVRFtAbkAsYJBJKBhllXSch7TYRIUZJy6SrVqkrIqhE0nwtG/f9r+4u2vsGMojuwVMWuF0ilQjtv1YPy/R5RsNnXprFu/hZ9cthVJlOuRyowe4d3RPO1tzSQsjVffPcJMIkvGEBiLJijlC0QCXrYsacYolVnV38KZ6zvZc3CY+MAkpmZx5QXrKFsiTreTWAWu/snDNLcJKBXw5wVUh4jbIeFUJGzbAtXG61bqp7NsgOx3kvBkSclVnLqC1+NFKal4TIvJaILoosG287YSm56mUi4jRhTyc1UyRoXFTJpWn5vhVBZPSCVXNjl8qERteV4VXD6Rig1NIQnVBS5DQJdsREQ8RRXNFvAaGnYWpoppWpxeGtwuovN5dLeTbNGgkC9Sskq0d3sp5ksYFYGcWCCs+hAyR/9mxydmOeGKn1FwVKnkbTo2Kkzvr1JK29R6SsUlUFt3/3KZ6KjMB/f/gKA/TGJikFt/9xifO38lrxyOMXB8kh9+9UJC4UZ+/+DLlHI5RheyxAUXF65v41On9HDPc3u488Uj/OILZ+GTKoS7ezlxfX+tj8WIjzJnBvnTQ/dTiWdwSgqaYaB6ZDy6hq5qeHQoyCYWBtVChZxtUtAMcp0CtmDjcbpxigqFjEGHM0h8IcqCp0xTqInFbJbEdBZTraVaB4upAtNTVc5aH8aHwGvzSdwRgX07KjgDQj3VaJZNpFNGMCHsVRBtq56iC4aNLyZilA1aXA2EVBfzmVk000ObP4hgiMQLeQx0ivkcFkWKlkE1Wcbl17HdVTILJkJ26O82ls41P/omeX+CyXEDX4tEet5kep9Rz7frT9JwN8kEm0R2vFhieXc337/oQxiHD3DlHz/grpsvorGzGwJt/On+J1lcTLCxK8xcKs9CqkSjS6Ej4qSxMcRpJ64lGo0zfPQIPW6T+549ylc+tRGrYz2DRwewfAFe/89/yCYMUCQcokVri4I/qGDVWjhdpGRatLY2k4zNkzeqzEsF5GaRkt9GLSkoloNyyaLXtYTBiSHm7Qxlh0CDU0dcEJiq3cp+lcVohXjGwq8L5OZgWZcLU7f4YCRPoF0i5BYQina9O2z2C+QsqJRsnN5aZRTwFmysgo0aE3HqGo0eJ0E5iCYoVEolomYclxpCLFuUczmqFQuXriDUGhtHiWylgPDKM5fYy9rW8dr7j7K7OMvO3RUCNSDhE5FTUJFtIi0KzS0BdE3nnTencIYkvtHxEd55+gN2lbz84qZPI4U6+c29z1IuZSE+xWfPWs2e4zMMTKbZtCTIB4MzvD8Sw+1y8+vbrqfLK0Amys///DidDovTP34huw4eIpueJzk8RUlQESwRwSrT0uYCxcQnq4TCYRQBNHeAaHwKUZFIVgxi7iQxPU+lYOMUnZSKJuuDmxmYOUyMFCnZpkNy0JB3M1KKI/cplKsGqZxJKmmRjlmU8jbLu1UqDgstLFFIW8wPGwiqQNArYGoCfr9Qb3X9ARFnmXqjISzaiBK0iE663T4iio+5RJJhaZGI7qZJilBIG5jFIl6vRiKbId9UQpJA+NKdPluq2AQ0ATHsYGQkj88v0h7xIQsBspOTlCWLUFeIsOlnLLNIJlnk1NzJNHj9/ODJAf7+oy9TMTV2TRZwVFMceutF8uUKo1OL9DV5WL+ii+HJKJ/44lUs2XoRhfkBZLtManA3z7z8Aef0iLhau9i7MElmfhTFrOX62mnLYksWZdnAXanldJlIcwuWajM0M0zBZeFUHVQqVaJCgXlHnnzRpFVxISDhljwYSpWpTIz5rEWrotHqcFOWKhTlKjNmpQ6ckkkLM2vjcwv4nSLOIKQtgfFjBmbBxuUVKNSaEg2WrFYoTpo4HSJyBUzRIpWxGd5eweEX+dDyMGrJQHXZFJ0mDlEkXPHilrwIRhWXplF0VJhf7iBTTSFc/XufXanYyIrI0tY2LNOgmE9RqVbQnQrpfLle7Fy6QFhuJexqI5Lcisss4BZsfvDAG3z1Mx/i32/s5zOf/BiPP/AAl335yxx65JdYuTyqIvPGeIUvXXcV6aLJfAGee/VNPnH6OiqJWX779Afcfc2pvLRjgI9efAqGNc/Y2ABFqYRQKBN0+LF1FacSwF2pURsVJsxZ0kqeoiWSyxZxWTJZqVivBYHagvVWVN3JVHmWxXSOvGDV19KS1+v/z4KcRihp5BST2WyZYq5W1EVU4b80R16GimFTyUOjW6Bo2+Qt6hSFQ4HVAZFgk0ZVd5Kfz6C6ROJTFYQ0rF3Zj6WUELwxRIcHIW8hpw20pIxYNSkXyzj9PsYbDZKODMLlP/LYwUaVhkAQTXIxNDtO2C8hShrVjIBZLlOWqvjRWBVZx9bOT3PLd/7M1R/dxvuHRvB73Kxau4Y9g9OEGlrRq3nm5ufRx94hOZdG0DWcfgeODRfREAjh6V7Go3f/iR/eeCVf+MZP2dYbYk1PA21tYQ5MFvj4uZsZHtvOaGYMo5wmqHsRxQCi4oBSDkutMCnMs961hJ0Lg8TFDE6vTLFQQUXGazlpa+gjLAdZKEwxkBplJFUgEtTotGpAMk3Ra7OYLmEItZ5boJC3UHQboQSiLZISTOKLFo0hiZAskS0KDMXL9VtZWLBoaRdZ0+vDr+vMVxLIzlrwRJrlNsq6i/zwFEVHDrlRRC5BtWyhFcCXVclLBhWXygwFsoaF8PMHO+ykWMa0RSRqxaJMqMlFMl3GzHsRpBReUWCF0M8ZG65iPObhpSceZTZv4ysuMju7QGDpFkbmFjnnlPWsCwm8/NB9NIV0ArkCVUFmQRQZKzj51NduZHBoBMnpp8sn8uXv3ckvL9/Ar148zjM3n8n3HzvMd67/HC4zxfH8fhZyg/iVAFRlcnKJpBJFJ0DOk6NZCDOeO4Ipqig13FEq41B1upxL8NsNVAtFFq1hLM3LQjJB2UqTzdhEUxUqtkCwwUehWKQvGEaYczKenULpNihmbQTTQnAKNRYRv+Go0zKDiRK2JFCJmrgdIuFWla1NDSS0BHHTwGNJBEMdLKSnSc6VaAzqWD6rzqXpCQlDtjGqZQq6SBmRgmHUsYbws4d77dlSAqdHxLYF7KpJwOEkNpXDUgQEWyToCnCqdx3rN9zI40+8TEdHG3+9+yFuPL+HQzsP4Np0ES+9+G/8YonVJ5zB/OtvstSVp5yzcOswmLVJWAorLzibR556C0mBVWu2ok/v56ytXXzh7j28+8+fc9nN/8ttN3yB/o4QxfxRDi68jqq5sNQS8WqUlJZBMkVklxvLqmLZFVRJw4n8XwLQNOp0gaJ6sUsqyeQUaVlEFAUEy2JouEzZkHDbIvFsCS1qs6zXj7Pdi1WRWfTMUq7a2KZFqR4ICIZ1rJKG6NWIZpNU8hZWycARkIjoTgpGHqdfRFNrTKiEUTQRDIuI7kBUgxi6RK48jy3bWLaFaGv1Lk6STGTTRLj3mZPsmdIshUoGQxaRBZNSyUaXJSRJwUMIHY1Pr7geTe9l974BVp90Js/e/RuCLoWXnniCQLAZx/ItTAzuYnI6x41bIijxIXIpE0WGiZRJ2xnn89sXdnHuGhnLtwpd9vDmi89yxUUncHwuwUVfvJmf/Pr3XHXRqWw9cTN2+hB75p9Gs1QK7jwLhUkQbGRJRHD6yZQzFK1cfc8DmhelWqRaqTBTsFE0UAQJp60QXSzWT3WDw890Ks1c0sCf/y+SrpQsSglo36Sx6DDRFIH5mInuEWhUHAgYSKKCZPvIaHl0RaJqGjhdAqlMHsm063ggEpFJJWv0vI1bEXDULo9h09zQjZXLkgnl65SOYVUJepooGllkE6LZHMKvnl5l59JRTF1A10MUqkmKteLn9uBQeshXFmkR/Hx85TcQXb08/uQLnHjq6aQmjmJWi1z5le/wrfVukobKlbf+jBuv/x4XBLJsWhfGLhvk82VS6TL37MyRbm7n3nv/xLe/fgv9xjTvp0WuuPTDhFpb6dtyFo888i/OP20zrZ0dKIUhto89xGJ1hKxdwIGGO1NAMQMUfA5yzhRzpTTlAqxQ4OiiBTJkkla9i3PW1uMWaZS8VGct8lhk5RxCQsfMO7DsDAv5Gn2t0NTlZyGXYDJR21wRy7bZ3NpLRHZTIUvSKZNllga5i+m5IVzNSj0wai7PgmyhOQRSs1b9c10NCoZoUS6DLUlotoiiyKSzeZweAY8jQkXIo5lOkrkkwu+fXGKTNcg7pBpWI10qUSpb9V467G0ik1/khOYzOGv5tZQNnT/9/i8cHZ9iYnKKDcv7SS1G6a1McEKHG0nzEp1dZEmDRseaZdiVCoZRYeroIHsH86R8TZx71kaO7dxF1azwz1Gbr1z3ecbmkrT0r+K+e+7lc5+4iM0b1hLx5Hlr6j4OLL5bJ+r8qodwxSCeKZNx2VQdBkYtZdrQKzSSThdgsYQbgahdJiGYdNbAlBaCfI3Pkah6SlQyNtWShLPkwNZ0PJ4m0voiI7FhkmkDq6ZrOCVaw2EarSUg5ag4ZGLyOLoYpCrZZHJTzI8UCQdEbJeMUxCwDYtsxcYry1Q8EtVyCdWEgNdDvlREEDRksYAoCURzFmZZwLAshF8/3GK7hAaychXJsolWo8SzBh2uIJYtoKFywdpr6O34KIYlMzcxxI9/9FNamyOce/o2cvkS87tepEstEJaqWPk0vpZmfA0tSKpeV8eS00MsjE5RUT24gyEGxhfYnxI588MX89ahCd587wOy+QLJXIHPXnQ23/3+t7GzYxzNfsDzg/fi0QRCTgmfqSDbXtJqgZiZI5qo4QCBpc4GnNEQpcUYbodOVigQFeJ1FUu3PaiCgGaFERUVVW1kJDeNs4aOxSIerYOiVWHRmMLraMZVS5u6Qk4ogOSiJGRRVSex1DwOJQhugVwxQbVs0OxspEKcYixDOB+i3GRg5/LMO0zyeRtZhYhXpZytYsoyLsGoq3iFGu1s2AiKhPCLe1faDnegHlVLVKjIGRAdBIouvJqfqlrlws134PesoLg4yfR0lP2HD+Lzh9i2aTVP//sx+iMaMwd2cXq3g4nBMTpWrcAdaawrMrYgkRgbZfbYESIdjYznVPbN5lE7V9HQ3MGZZ59Jpljlf376OwJymdt//jOc/giF6ABH5t7j3ZEHMNUiVUwCThG3rZIwKsgeF4VsjlqzEpT9eMwIyaF5dMFJ3lMiP5dEE2V03USKOPB4PQTzjdihFmbtBVwOAcnOYltlxKqTklKudzkeuYdKJc1MfhRBd5JL1/BGjnxaoMPlY8pMkihXiTgEPJoLW6igeERUvOQrWfL5Em4ZcrZQ3+SagtftF5kp2oSaRRyaE1HUEHMGhUwV4bo7Gm2Px41uGDQGu5iShzEqJt3lCAk5QWPLei5Zdzuy5KFayGNaNgsLUZ555gX8TpXB48fIZTJ8bbWBR1NJ50q09PWjeQPYlolplFkYOk5ibp6GsItkqshBfQnTRpDTN/axfzSKoqo89/yrfP+Wr7F66ykouptiZpa9A8/x1PZf0NOg4nS6cZkW2bzBrJUn0tdHdHqKklFAl8GPk2YjTIvdRkaJEpF0FDVCsRrDVgXMSgUkJ5YiMpwbQtJkXLq/Tp55NYGstMhsNo1d8dEoe0BOUHBJFKJ5qloVS42gGTppw2B4YYQOrwKSVde4PbWWsyRSqpSpaStyFbJ2tV6IXSUZpWBTYxFTullvRb3+YL2rqmTzCBd9y233Nek06kEaHG28W9hLedFiW0MvO0ujrGo+mU9u/CaKpdT1xqpRu14l/v3UCyzEk/QEFbo8sFSO4XE5yKXSNPT01pls06giYpFbXGRwcJL2iINkIs0TUxKjGYGvX3sFz7+1mx37Bjhr8wo+/qlLaWzvRVI1ZFnm6LEnGZj/B2KpgqsgEhWzeDSF44kopiHQ1hpgJpOiUKjSEWnDWxN154qEGjXCto8os0i6jaZ4KclFFHcY3TRYYI6sVaKCiYcgQYeb+cIMedsgWPLhtHyUnAnEuBNDUnG5K8RyVXSPh8MzE8zMFehp0slmazVHRvBY9dRkTUGLQ0P1eTBFA6lqE9BdpItl4maFAhUiegDFa5I30+haGOGrvwna/f4mJBR8Qphd1SN0F4JozkZei+9ha89JbGv/MP1NWymkMlSrFeYW4vVoP/jw4zQ2txMSMnyoT8UjG+yLGqxYtx5XJcrCzAxVFFp0i3i2jK6qDExEMRv6qUoqj799iB07dvE/N3yR7p5umtu78QdDZNIJ3B43peIsg0P3cdAYoFPtRBTzOMRmEtkJ9EUFvUXFROTQ+Aw+ICxFcFYrrGruI1kUeHd8hkafh1NWNFKQFbYfm62njUhklJhSqKtcJUXD4aiQMstUKlm6XGvRbRdzxkEqaQPJ5UAXK3Xp0uWo4QU3hbEspbzATGKaBp8bV4OHqqOEjlTnryJikJFcjLjloK29hebxEm4xwgH3KKbTS6vWQjhfxnYZCF/9VcCu9cjuQDMeU2XfwiBnezdxTI4xlJ6knFG5ZP0nWBLYQtjfRCqVRXW5SSTSDA8NMzI0yLr+NoTkJJVElEVvH9WDuzi7u4FyTX1Kp3h8JsflV13G+DtPs1CzYkR6mY4XODw0Rtjn5tJLLmTllm11pSgZmyMU8BGdGkMwDaafe4jGlgAVWWM+Y3PGlh6efOcY6VyFr1yyoQ6+3n7vKC1NAR59d5RrL1jFB4MLVDU3l5zaz/j0IocHJjlr20pe3TnI2wMxAn4n1354LX6XSDGTxhSrFDSFV3YeYfdskZAucv4WBdFnslhOkzcyKIqEoqiUHR6kvE78cIxsKkNwlYTocFEolZieTVEWYW1/C2VZpFw1ySXLVI5lmcsbBNcJpMZMeh0+ej0Rkk4D4Zd3L7MVb5B0Yp4GPcKe2AAXtVzC9tK7HBlewIOPK0/9Kt5KBH+4hWSmQCZbINLQUNdoo4spRg/swimb9AQFWrZezD8ee5Il7z2Fs1zmj2aIO37+Y0qTRyhnoyiNvew8OEZLZzd+rxd/OFT3FOXy/wUrUyMjLG0LUKzaDOzbizw/zsL4KOdtaqGk+dE8PiJBJ1+9632+ct5yTtu2jHKpws6D47g9LvYMzPCZc1bwvXu388kzV7JtXSfFTJaXXzvAhz+0iUdeOsBThxfpDupcffFGOtrD2Kk4mtdHdCHBUy/v40vXfBjNF6B47Ah4vbz89nH2TiU5cWMDa9aGyBWjTAzOc2zOYFmbiqNRZLY6TbRUwLRKBHweKlqOatKgUPTjtn3k5AWkiI3HlKiYVt0A4MCL8JuHemxJ8aFXBXyEOBY9QId/I0erx8jnSkSkFgJmGwFxHauX9VC1RAzVxQe7j3Jg/0EuPP809u8b4PRtK5kdOkzJklm57TSeefhB5sbHuO5732b4+CRvvfYShUyGL37+Ug5OZlm3aQPRhRjpZIplfZ1U8mkUh4v0+DHKU8M4G1s4NDBJcHpfjV0gli9w1roGZgpOzjihj73H5/jRs4M89p0P1Tuc+bkY9781zmdP7EDx+8nEU3z9od385gsns7K/hdT0NHpNqtRk7vjzizi8Hs7p9/Gd/4zw9++cS7gpwr1/eIxtZ5zAyg3L69qxlU7y1PO7eWTnNPfd8dl6WrSrZSb3HEZ26DS1RCgWq4zPJnlu5xQrlzhwrptmQZ3BUBUU24FUqvFpfmwljaz58RerxErTJCjT4O9DuOehdXaumiZdyOEuqei6j1QNuSlpFBz4y04KGR3zWANnX3AO/mAD8VyFocHjRONJpqM5gh6NwSOHWbl6OQ0BL5qqECsaxGJx+tsaKWYz6A6daCLDWDTPquV9NDY34/F6oVxiSX8Pk6OjdReZUCqQ2vc+wwfeR1B1tvS6eWH7NOlKlZsvauLwgkBHa4hwU5jfvTRBJODhcxesAUHk9d3DPLFzhls/s4lQ2Me9j7/P2+M5br3iRHrbA1AsYVkWlsPJnQ++zdJmN1ZikYsvOxMzm+WW25/gS1+6iJXrlmFMjzF4bIIfPn2UX15zDu09LXWfU+02PfzEdg5PZep0fG9nmOXLOlje00QsnuTlHYO09Cr4u/KMlBZxNGnoWhCpkMEuWXjlEAvKKGmxJubUUtBfOu1qLI9QAwllCYceZlqOo4R1Ot29WBUVK6+SOt5B0C2wckk7i+NDZLQQE9EcE2NDdLa1kTckXnnzPU5Z24OlOjk2NIqq68iiSH9bhLd3H0F2eDn3vHNwiDYOVWPF8qWoqoKmO0hHZxBzCYToGNLUQQaz4Cyn2NCts/94mh1DKW4618tgQmbVylZEzc1Ussw9O2L87OrTycYXyVYlfvDA+5y1eQmXf3Rr3VRwx12vcWg+z02XbmXT6jaEUhnR5WZsYIg/P7mH+alp/v6H68nOTHHBTY/y0l+vQ7HK2Lkktz3wAY0NQb72uXMxEvPMZSr8+IH3sAWRK07r56Qty5E9PkqZFOmFGOPzGTas6617lg4PTDGnpCj15evcz2w0hluysQWVI/E4Td0qhayF8I2f+G0lpiNX8tiyzGy5jOARWd7fQVukgcH0EH2uLex+qorb72Vl2EJSXew5PMbYbILmtgYmF4uItZZTkrji85dxcP9hvL4gnb2dvPLCK7REPBiCzKNPv057WysfOec0xEKyLtj4V2wgOzGOR9MJuQSk2UE8doK39h+v35SAEaNUzHNwJMeZK1SOzFRZu76TTN6mtTXAo7sSXH7eKkRZ5qW3j3D6iSv54v++wR9vOI9gU6xmPsAAACAASURBVBgjleTW+95hf8zgqxes5aLTV2AVCliSyOe/fS/VbJZH7/8uQ4cHufvBl/j57V+hNDVGPLrAHU8d4zdfOx9ZtMjOz3DtXXuIFkr842tnE4n466ai+eND9drj6egGRcUsFZkcHOPNg7N0uuBAVsPZapLrHsYVVBlZTJFM2kSCYn0Nwtd+GLCV6SphWadYgahdoqWnCVdEJy3WVP0il/k+zuvbFzkyneDcDd0cPXQMkSqT8QLelmaq+Tx+nxe37qB37RYaarKhUaFczNZBncsX5MiBA7z3zJN0hTyE/F7mcjZFU2Npox+nUaCxqxM5s4Dk8BEsDjFRVPCaUWSnF93MMTebpK3BSbZQweH1UVIchFwSB+YNVvU00trVwu7j81iIjMxlSBRNvn7VOdilEuP79vOrl8YYSJt8+9Mnce7mHjAtfvHHfzKeKPHH//kszzz3LutW9tDRv4RMbJHb/vwi1156En1djRjFAj+86yUWMwV+eNlmQgEP8fkoNbNSoLO7bmg7ODDFy3snUYslQh6VRp+GO+ChrauNBq/K6EyUhyePEDo9SSJdxYpZhMNehJt/FrTNxQptqp/FhRKViFTnqRedFaQGmdP1TZwcOJGFosh3f/sIZ564hqXNLsYmFsjlC3hbO5GsKp3dnQwcOICteQiEG8lXRYrFbN2HU04lceejeCq10gNvHs8RcjjYKOfx9SxFFQzk9By+phY0hw7BVsqLoxiihlqN0eAWmZ6I4tPF/7rGdCcNHWFmEyaWbXJkusBnPnICs/EC37x/B7+5+mTuf24fN37xApxOjfTYMEOjUR7eF2U8B/fedAEiNrH4IgOTcS46fS13P/gCV3/+4jpifv71/SzrbKBvRQ+JiXH++OwBHJrGDZefAbkUyYUFRM2BKxRiamKWPYfGKJYtNvQEaetoJFaRKRXLLMzMc+DYDDPpIql8ha5mP97lIqWehTqBt1jzLt/2swZ7MlFgk6+FWNWsI0SlUiQqW+Rkk1tXfxGt6sbX2MKX/+dvFFG45ZqPM3TgAOOzMYJOgc2nnkXFNNmzd4AlXWEeevY9Xtt9DK8q89GVAfpDLrxBX92SmE2VuWyNC8WoUg6spjBxkKbW9jpno+WiOPtPJLMwg+hzEovnkM0c/a1OyokYiXSFsE/BF3LjaWzk1f0xNrU7GZrIsfXUVeAJ8e0/vIQ74OX/fHQzv/vHu9z+9Y+QypW48S+vc+W6ILe9McsZy5o5eWmAai7BOeefRimf59d3vch3v34JA0fHCHrdtDb6yRfK/OD+d1jml7n6yx+lOHoczetBDjYyeXyYJ57fy+b+IMcnkxRrZGJJ5MB8FqdocdPFK1jR18TU2ByWJLEQTXDCyWtILCzy1vgco31TCG06wm2/aLArokWX3EPSKiEulEnGE2i9TrANruz5DPlcmaauPp55ax8/vf95LrnwbD56ykr+9fRrnHPGVjIVibnpKdavW8lf//kCjz//Nudt7OFjJy3FaeV448AcFHKsa5Rp1iw0wWQqblCoqrR6JHTRAH87gco4sqbzbKyBc/o19k7kWRKWaNQKlFIpUikDt0emo8mBq7WV2/41zA1nNuFvbkbUnKDqHNlziNtenuesjV187Mx1BBQDNdjIjb98ksvP6OPoZJKHds3y8Y0Rpsdj/PDbn+WJl/dg57OsXb8CD2Uagw5e++A4bw3EuWBrLyetbsc0DUSnu94JHfzgEPuPTNcDG8sUWcyUCLgVTl3fzZrlHbS0BLEKOUYPHeHYYJS+tf2kihUefW+U1HySk5cFOPn0XvY1xRDuvK3ZnqpmsV0hgqEQsfkoEWczQVunTZPpazgJKkXCDWFmMjbf+tUD6G4/N139KUaHhog0RuqDGm1d3Tzx/Bvc9/DjXLCln2s/cSoTo+OMTy3QqpZo94rYuRTVqlHP2zMLJU5slHC7VJySiag760MXbqXEU6M661oU9sc1LlwqEY9lcUsl4kkDzSmztMOFo6GB7z89waYWnY+duQJBVjELWcZn0xwYTnDH9gXu/z/nsG7zWqxKiUee3l4fCjl3QztX/vplLj1lCYvxHNdc9RF++8CLXHZSO816hYW5KH97Y4rBeIk/ffMS2hv9WIbJ5EKa48Oz7Nk7SixfRRJNVndGaI04WN/bgL8pVPcY5XMFwg6BufEJ0qkssq7zzP4oiqazYWkDXSGVQ8emOWNNI2LAifD9m/22prtJlAvEZBOHw1GnAFrUCJ/tPZNC0Yvf46xP0Ci+dh577i0eemEHn/3Y+Zywtp9gYzOVqs2f73mIwYEBTt64lI+eu5VdOw7ilwo0qXlkq0w1myaerfDb12Msd5uc2azUZxH8XoGaLcapiXhbm1DLCfZOW4wkbZZEVDb1+xgeTuLVq5QqNdVLZUmLgu4P8atX5hiOF7nnq9tAdVAoFBk6PEJni5+bnpjAFEX+ceeNCDUxPJvh+l/9h+svXMk3/vIqP7r+YkYnF+nrbOTo0DQnNxZwKfCRO3dyYn+E33zjEgTbZmYmyU8e2slcukC6XKFBhZ9cvpm+1UtrxiUsQWRyPMojLxyoj8d87NQu5iZjDEzn6G52MDid4/KPb6n7RHd9cJw3945z09Vn4nI5uPvx7QjfvMZrp0QLvabWKzJBh0ZRgHBZ54YLb+H9vcfYsHop77/3ARtO2EK0IHLptT/glK0buf7aK2hsaOTVV99gYmqKkEfntG0bKMTnID2DLlvYlSLFYpGHXjvG1OQiZzZCAAh4JIJ+mXKpRqeB063i8WgkchXMqsieqEG3B/oaJIbnqrgcIgGXTLwssaRRxhUJ88SeGL97Y45Xb1yHHgxiyG5u+OObfPPcNv6xZ5EnjiR46TdX09LahOgK8Ps/P4pVyPL4O8f4xIe2srq/m5GRMVrUIj6K3PzYYdZ3e7nj8ydhVwxu/8deXhpM0hLQ+NI5K+lrctPssJmMlxmcSjKeKiPki7R5ZVav7qx3NQc+OEI8XaKtI0JXswfZG2LngTEGj8+wojfIiSevqXNE377nHY6OJxBuv6bRLgYlFAOyHo2gC+bzJdrlMNed+z1+8odH+D+fv5ixo8fp6O1EdAZ49PHneOzV3fz6pz/A43IxPDiIbFc49eRtFBZGsAuLWJUi2VyRXQOT/OuNo2yM2JzdIZOanEdVZVxuFanm/cREqzmiJLluet03WsBV49llnYBaM1SJJJMGoiaxpElibFGir8OJpmu8dizNDY+N8OYN62loj2Crbm5/9AArW3SWt3r59H2HuOPzZ/DxT36kPrczPz7O/977DEGHwPapPOduWUlrow9naordRyb4565pHv/6RhKpEj/61wCHomXO7Aty9RndRDNVxtMm08kS8+kcfo8Lv22wrcdJoLGBVCpNOV9lebefpiY/gsPNe7tGGBqapy3iYuu2FYRbWqiWi/zivtd4ec80azo9CL/9RpOdztg4ZY2CW6LQWEWxLU73n8SJ267ga7f8kvPPO4UTV3aSSyfxNXdRFl1cc+P3+dbXr6Ozt5/Y1DD9S3uRjSJGMUuhXOadXUf56Z//SToe5+lbP4xbtogf2o9VzFMV1Lq24A15kMq1Ib+akdAkV7F443AWTRbZ2u9HE6qk8ia6Q2Imb7Opx8lk1KC/N4CkqRwYjHPZA8P888plrNmyou5Ee/i5XewbTfH9y9bx1T9sx+Fz8dCffwi6i2oxyyN/e5D+djefv/M1zti6mp72RlYF4JcPv8XFmzroUkrc8PQoiarBzeuCrOlv4Iyz1qL5G7AUnaopYhll7FIeiilefGuQpw9E2dwToD+ssKK/leaONg4fHuWJN49xYrtG5+qVLFvVX+MeeOXdg/ztsZ3sS5Z54eZTEP76g5W2QxLwO9wUa9eLSZSigw+v/jJN3SvZvecod//7dX7xP1/HLmWwanZxfxN/f+hfrFq7FofLy+plnXVrI4LEu+/u5K5/PM3BfQf4xKlL+ew56/FJBQrzU5Sj05TSBUqCA49DoFqu1ocnPHptVMjgqYMlNjbYFESVsC7idkmMRKv0tescnqpy2movIzMVVvb5kRxOjozGuPS+Qf73wnbOO38joupgLF7hil+/yF+uO5OR0Xl+9/oIL99/K9ViCUHWiE6PYxdiXHnH02xa2UNrRxuNmsFfHn+HKze38rs3RylWTe76VB8nr2lmMCHxz/enSS1mCGgypiDhVqEtqNPd4kGomZwkBaNaS50GbrHK5hNW8+wbRxmZjuOuteIXbKCpraWOMa76yeMUi2W+ftFKTljdivCTP/fanryEYFYJ2h7S4gLrW07GIW6gb+1qLNXLL3/xZzqXLuXskzeiGAUUj59YssD07CIbtm2tO9OqtsAzTz7H9nffqRtyLzxtDS5dxUjNIxeilGMzZOfmSMTLlCRnfV7KqdYUkQJm2WA4WiWfreBSJGRdxa3VHMgq7x4psmWVj9H5EietcDMxV2J5jQtSdI7PZLjsr/u5/fxOLjhvHZInjOAKcNWPH0UVLc5aFuFnzx7l5ftuRXIH+PVv7uI7N30ROznFF3/0AP5gEFlW8Xld7Nh1kBM7vTy8a5IfntfF0haNv29fZO9oso5keyJuNnQFOf+U5cjeIFotfWpS/UA+8tQORF3jxNUddRa1u7+b6clp7n1iF20+jSuvOAfTsvjpPa+wZzjOR7a08cWPbcNMRRH+8r9LbNWhkk0mkHQJnxLm/BWfIT2XJtK1DMnhZzGZ44bv/Jwrv3AFm1Z2o6oaZVMglsjSvWxFXax46dX3aFGzOF0OIn4numxTTs5j5JMsTk9hTR0jF12sixc167mnNisVL9HiMajkSuw4lKenQWYsY7Oqy1EfQ6qJvTPRCppHI5c32dDvJZ4q09PpQ3G767MHl/zhIDef3sqlH92GGGhB1L38/pHX+NOzezm9v4PXjgzz+t9uIdy9jAuuvIULN/dxw43X8fd/PMED/3qJT37iYt7duR+zWKgreCd0e2nzqdy9fZavbApyyaldBLr7mZua49f/Ocrbw2lkSaA96MIlw4e2dHHW2jYWxqfQGtsQKgV6lvbUDQm33/k0l5+3gq6VK9h/6Djfu+ddLt/azCc/ejJWOookKwh//fsS22P7wTJQLYXTln8GpVrBiM1x7MgUfZu3IvpbiaUK3HnPv1i3eRPnnbKBcrGIKTto7u4nU/OAxidJTQ3VC6lXLNSxg1DJItkG5WyGzOgA0yNJHJFAzXKJYhv1tk+wSiQXy2TSBoIksjMhcPGKmou5Ju8qeB1wJAo13TrkstgxWOC0jc0EIgEmoyk+/seD/PjD/axa1kr3qrUowVYOHjrGxTf/jUKliltXefXuW2nrW86VX/sRR48P88xdP2Y2VeJL37yDqy77GG9s38vqpR1MDw3R7zI5Np0gXqzUb3WmbNb17ZrrrWqa9IcdrO5ppC3kp2pUmInlOHlpGJcqU1V0Ni6JEE8W6F/azq/veZGPnbaUaCLPY9tH0EWZ2649t653G4sTSOE2hN/+pc12Z3Wcip/NzeuJhJrqdgq7UCI9cZS3xmDrtk2U0CjYKq+9tZNl6zbQHtKo2VnaV5+AXM2SGdrJB++8R1dbBK9cwqFKVEt5SqkkVj7F+JERDs1VUVSdjrBOk7vmwayp/FUyqQpG2WJH1KDJo7GhXUFQZBarMr2NCm8cL3HWukA9KLc/OcVXzuukp7+DWMHk0p+/wY8+uQ5bd7FuyxaaOnrI5XN86dt38uLeYXRF5tW7fsDyDZu5+8Gn+N6v7uazZ27gc1/6HF/+5u10dLaTzWRZuWIJk8MjhBSDtw9OMZcvsq7Fw6Y2NxeuaWF5VwjN6cTp0pFDbdhGhdrclqDoPPP6fjb1hXh7zzinrWlicirOxo393P7ge0Qkk90TaZZ3h/n6Z05FtM26P8k2qswmKwi//0O7LSQsgqrOecvOR/SEoGyTPr4bSw/w3ntHeGnK5PILtnDo+AxbTzuRqimzb2ia9UvbWHPqRWilKIW5IYb3vlcnp1SzzNK+lnqOrKQTHDs0xAPbk2zrcnP6Sk993kym5q6oEl8oYNTGPz0irw6VWRJSWN/nBo+HeCxD35IQ7xzKcNraEFVB4dYnx7jloh66ViylaBhc89tXuHhjN5MFm1LJ4sc/vplqucy///MS3/jtP+szXa/c82P61mzg3ff3cOl1360DrId+913ufezlOqWsSBJt7W1MjQ0RMDI8u3uMz29o5NqPrECzq9Qm9hSHE1vW6htnV8rI4WYo5euFPRFbrJ/6p/bMsbrdR9CpsHZ5M996cA9vHpjmhZ98jOYGL6KkYpv17w+oA8ob7nwe4dU/fduuieAt8hySUEAwoLQYZWIySt7WMEyL7z10AEuTOX1JiGVrVtO6ZCljk9OMz6e4+rqv4CgtUJncRSU+z65D4xyayvLOQJSQz0G3X2eZu8KWXg8KBkZt3LMMc7ESpWSp/tUFtSnEvx4tcUGrSn+bi/4OB6bDgVU18TWFeHHHAh85eym2JHPLXe/zg8u30r6khwIy1/3sCS46YSkv7Z9iYGyal+65DW9DG+/sPMAnrr8Djyrx4v130LN8HW9s381VN95KJl/knp/dwpMvv0skHGQ+mmDLllpaLZCeH+edD47wt2tPpRJf4OE3j7N3Lke6ZNPu0VgS0Zkr2ViGTcEWWR+UaQy52dCh8Ze35/j0tg40VSbU3MTn/vA6a1sC/O7mS+u4aGFsmKbWJmzVyZ1P7eVvz+xC2P/Iz+0GKY7mKGMXi1AokEkXGByZZWg2R0dnE2/tGuG10XSdwt3c28Tmk7aSL5ZxaSKnn30uQTlLcXwv2cV4vd92KgKlXJbJY6OEPf+d702kDRaT5frXEHhrc7WSgWjapIoWL/zfGs49uq6yTOO/ffbe534/OSf3mvSSttAboFQGcUSBAjoFpyIWHaozxUHHcSFrcFxLEcvSEWd0vCDjiDozDhWtYMV6QSyUcrVQLr1ATZumSZqkuZ0kJ2efc/Z971nfVyf/ZK2s5Kyd/b3f+z7v+z7Pc9bhLzujmChU8nE2rs4Ry6clujKTbTx6YIi//8ClWIrG333rAJ+6bh1b3nsVlq/y1Qcfo6+zyCMHjzE0PsOvvn0nay56O0dODHPrp7+E2Wqy7/u76O1fyf6nnuG3Tx1k0wUredumC9m97zluvnkbTz71LGs3XURci1CdmeLpg8/xyfcM8J1HXpA0moFilNuu6GHjuj5K5TxnT5/l1FiVlpbih8+Msr4U5ZoNBb739CRXb+yQtc1Mlbn/d0f4+d3bKRXS4LssLBlMLNh8/7EXODo6yxYBQ08+dEdYoipnKVrbcppDhzHbLuboiVOMj5xl5cq3MHVunrlag9H5Ojdcs5l3XPl2wtkJOZtvLhno5hy+3SCSzBOJqPi2xdLIIK5lcm66QSEOsURUklFbdZNGrUV98bwCc89Jm/f2xzlnePKFvuuiLIlskmS5QiGjMdbQ2X/oNJ+69d1SpXjLV/ZxaV+R++7+JK1A41s/3iep6cdG5njmyBD/+bkPc+X1N1A1HD7z+ft47egb7Pnidi5e1YYSS+PHctQnBnGXqtjNJrVYNwvZlWiZMmbTwLYsThw/QknzePh3L9AeafHNmwdIx0M5BdBzFdRyL0OvvEJ7QefVkRY92Qjf+8Ux1LhCLhVjeV+Znx6eZnVHig9edxnJpPDeaHDP937LmTmDjd05tr5jgIjiosz/+jOhN/IGYc9FzC15dA6sx4wUJe/9ud/8hC1XrEf3TLTAQvFMAtsisEy5MxWqP8EKCMTCWYuhRzVqlkJK6ngVVCXED8Xe3UYLhGDZYmG2xXw9ZKbmc3zGZV1ZRVVgohayYkWGFcsLUsjQs2KZ1Ii/OGbjez7v27KZsQWHj9zzY1Z1Fnjo63fSCOP8+4/2UkkEPHt8nBePn+bGzau4d9cXaBFn90/2sPXylfTHmsQSCfRkjlCL4zcWMGYnmJmdx1bjRCprMSNJqbJZnBxhaPAkDV9hYmqeL+94J8bwcVTFpqeSx3YDZg2fh545y+BUjXu3LqejmGDva1VeGl7EFoPMclqSFd7/nvXMLJnMLPnMLhqMjU/T25ZB0VSm5oW2IUCZ/c7VYajHaUzNcDK5nouvv4WG8D2Yfo2ENUKwOA2hT2C28Jp1KdkXhch3XayWJccSMVVwHj0sy0GNiq4QUukYQocZhqGkqfuekP+0mDhrMVULqBo+vUWVxVbAyXmfQjnB+rUlymL8q6pyRtMMYvzm+TNc9rYBNl36Vk7PNPjErh9IJLH3u3cTxFPsf/oQ5UKCp149w+5fPi6Z0P9x7x2sXd5D1prklNtNX18v1XNjkp1x7lyVwHMpqCaKHiFV6qDYO4AeT1KvzdOszTNfneXAU89JRLepPcnX973Exu40Vw7k+dmB05xphORLBeqOS69q0deWQijUDk8Ykt4uxuo9pSztbTleOTnJxHxddr9RNUIhrtFRTNNZzNHVU0GZ//nHQ99sYgwPcnxe4ah2EZdvfivukX1csiyCbyxKZQpOQ8pvxMMLWrXrifgUIjcV3/VlGy4cKKwghmOaxHUFNxAjBh9NV2jUTIIgwvSUScOKSBcVx4XnRhz8qMoFl3ShaEl6uvMkxV6gkGep6TF4eoYrrthEobOHP82Y/NN9P8BtGuz55mcp963CaNoYhsGjTx7iRw89iud5bL3sQh749DUMvTHImJviSz96ks/vuJbrLqlgGks0vDg1y+XpPx5jahFWbdiAFgQUihkyuSxdhQS6FtBTjpPwGkyfeoNH9h7mYx+7hkh1VN7q1KpLUHMVHvn29yVk/eVZldGJaWqmLfuGSiHHmp6iBBl9XSXaKhVymRSBa5FK5+hatpzq4hLKwt47w7lXD0q+jJ/MM5JazyuDVW7MjVDSTZRQRK/Qjgk3FUXy/XXFxxdOKpqK5/o4oS5JuyLH244io91xfbRQyHJCAqG7CgPpkzM750vDDaFHe23cRUnrjIc669ZUyLV1SE+dC/pLmIFGIR2jXC6hpYs4aLx2cpyvPPAwtmXywN238ZbVGySGn11q8dPHnuD3B56Xaesfdmxj5/b3s+cXv+bVw0e44x8/Sk9bijbdRG9MEQYuSugTuhaRdAGl0IniWoRm8zy+12OE9XmCxoK8/Z7tMHP6DJFIBD+VJdQSJFIpmotLlJM+Og6tTC83/NvTDE4uSKZfIZukVMrTUSlTKubo62ynkk1gN+tyLBEoKosNB2Vm//2hOXoYv7VEtr2HM2aB7977AJ/bkkEjoNnwyZcSKLEovmPjhRE8z5fcF8GSUyIqaiIuD0Lgb8fxMFse9SVH8mcE+0BEhPDPcZwAxxZs5QhzjVAqLRfzKRpqlEvX9yMU0q+fGOVtG9eQimt09nTzlv4VjE1MYLVaHDk1wX89+gRNo85dH7uBzuVrOTMyypmJGWr1BocOv07NaLLjr69jYWaaJw4d5dorNvON++6hrRjHGz5Ea3GGuFDUNWcJrCZqvh1FiaCoGmEQyImlOJhQRBohVr1OPF/ArU7IcYXvOkQSWRYNi8mxKZavX0ch6RM26+wdVvnWYy9LSZJYV1YNS6p4xFcxk2J5ex6rvkQ6naV7WTctX0F59Yk9YUF3aE6+SS4a8Oz+Y+QnX6GvW5dRKqacwXnxIZFYjFAR7iVRXMeXEeF5gWRMm0JvFVdpNj1sO2C+6mI6gbyuTqAQEbXDD0knI2RSEY6MepQuu5D/PjBIT3uRrkobWq7IzNQUc3M13n35JtZefKmcO50ancSaGScRjTA8epaL+yrSxatr+cD5G9hYZPTMCAEBLdPlheMjHB9f5NxinZ3bruf6q97F5VddjX3qADWlQH7xGJpTwxNCLtuQEFEQb0PfRU0VBclOgg1x87zApzp2hnL/KtlU+laLaCItCVnG+CmODjWxIxprBvppW76CRw6eQCn10LI8HvrZXtZs2MjOHbewdmAFUS3gndfcxES1RndnJw/ffw/K7l23hwMbL8NoGLz8h99zwcJR2tIWOeHoEfhENB2j4ZEuprAsD9uPSDKsMHSyTY/FRVdWc0HLMKzzUS5mPTFNoe4ELJlCqioO6vwhtndmUDN5jHgKP6bKLlM4comoER1yf2eero4K8UQCLRZDUVXq9RaBK17SecmpsCZIpLOEgqIiKL2+L3euiURUDspef/1NpucXOfzmMA3L56orNnPDtm1Ux09RdzTWLS/hDr+IeW4Yz6gTy+VQ42kCNXbeDicI0JNJ9GhCWo0dOWvyvg9+hCf+sJ+hc/N85OabeObFQ3zzwd1yPHHX7Tu49cMfkDfpyd8/zvY7drH9hvfyoWs3c/OndqHHYty18yZ2bruKk4OnuOb2L9O0XUq5DMoPv3BbmGjvZ+TUKNlXf8WmHoVYIY4nHHEiEfEsEnoZDZeZeZsT4zZzhkdWV+TNEIoZMaiyRF5HkU5QqqbQFJ2iEkFNxFizqot0JiP8y1jT3ykF0LrYgOmaXJSLzyjk0tJdUZh/+aGQowo6uE4ipsu6IxSIQrOWEI57oSIE7rLuiJ9pUV0KQ9rKJeLJFMLQwKib+IHHzPQMjx88TKqjn462HMdPjvDB911JMPUm584MM1u3CTJdLHo6a1cuJ14os//gs6iKwm23fxzLqLF1+w7u/9q/EI34fOKzu9j74L/KW791510S5X30xqv53M5taNEYh19/g+3//A35/A9+4TZOD/6Jr+55hvV9nTz0xb9heGKWW+79XywBQUX4rO7sCFOtBltXamxcKTRPKqoeYfJcg8kph6OLHmOGRyyi0JtViasRjtZcJgyXK4txXOGjJg4hhLO2j5KIcvOVq+np7mJ2waCns4yiqLTL7wqBH0ghnVBPisKeymRkh63oUZpGi2p1iWJF9ALCmSRHJp2mOl8jFo8ijlhspHRdIRYTN9NkfmGJZFTM5jXKYuUnFImRqISDqVyW2kKNE+SFMwAABHpJREFUxZrBhQP91FsuTx54lpEpg98d/CPD0zPnYTXCGUdj88XrZFQeO3mGLe+6nLphcNPWa/nAzs9wx99+iJnZWXbve5I7b91K6Dq8/KcRnn99kIHuEp/e9k6JCP944iwP7z8s/9cbN6/Eajk8fmyM9b0lPvlXm/naIy8wOrck60JSaJ43RGPhlq4ob70kx5gb4+WhOlsuv5BA02na8KtDJ1AjKmv6Opk8N8MbZ2eludLkoilRqPBuS8c02vMJ+jvyVNraWNFTYll3hXw+T3tXp9yXCsZCJpuTq0cR4b5lS7uWrKB8hyGu6xJRREpSsG0HNB3Ldv9ch6Jowk0wVGSqEd2qa1nSIkbVomjRKIagR2YSckI5PbdEPpcjms3JFytgtNM00aMRDr10hPv+59dM1xryVv3/VzKqs2HVMlb1daPpOq1WSxpElfIZXnpziGIqxtD4LL2VPNcKduDKfhbm5kln0xIdKpEI89UqyZQYO3hC4i2NT8TGTOYG38NxbKKJjCzuAoKmElGU7e2psDuvYrWXSBfLRKMqxbY2me87OypU56pU2tsoFfNEoklsu8Ufnj/G2OgYvu1QzsXo6a5QyGVZ1tuFGomQy2YwbUdCNYEu8tkUzZYpybvJZArPsbBtV1IzRNcm6IgCv4v9pLQUi8YkehAdcRBGcBxH3iLRaYtakExn8V0b13ZkDpb2SYFPIGCiqCdRjWg0yuzsNJWOLnmQuWKJiZER+fN0NsP4dJXB4XFefvM01/3FejZesJJUMoUai0vli21aJFMpuQMQqE9XQ/lsoqmMZdIyrzcbTfk/iemq64dYrSaFfI4wIqRKtjxI0ZQZjaa0axPeRq4byINxHZd8IYty/epyuHFtL4Gi0dneTt1okkjH6eoo45ieXErk8lkuWN1P3TBlfrUaTbnKC3A5OThCVFcpl4vSyna+bmH7IaFRo9Deft51MS4KZIxCsSitbywR4HhSLNEyWmQLOWKxOGarJaNEiABFWhJpRijSE7k0drMl042YJgqtgd00pJWC6wUkhc5AmOeZpjx0yzkvDhQobmJmUUZpTFPxfZ/evm4swyRTEGYdFpHA5ezwKJlinngyI9Pi5MQYejyLHk9QzCWlz5u4oVoyjmM6KJpGOpXEdWxpP6PHhRtiktr8vKxNvuMSyyTJxpPS9qdeN8hkUtRrS+ISS1HK0NAovu+g7L77o6FRb1JpL8mXX+lsp9V0SKWS0sAvFtNk6y9Yc+dtiMFXk6RiqkwnM9PTRGMqDaOFFouSiEbl7MdsNqUJn2VanJtbor1SwGhYmJZJd2e7zLuqrpNKpmV/IeCtKMG6phPRVJm7U3/++1JbGT/w5SZJpDLH80jEoxJ9aZpKPBHDalqS/KRqGka9IRuohPhsgSLC8Lzng67geD7pdBrTsmT2ET1FMhaXLzFQ45hLNfkcgmUtJFjidwXqE2lMzKQM22NpboZsOkkyLZbyKpbtkc1n8GyTRt0gkcrQatSlA6+YsDYbdfl5aHEp6c2kYrSWavL2/B+19USlgWbKjgAAAABJRU5ErkJggg==')" }, "modifiedDate": "2020-07-21T13:26:45.638+0000", "title": { "value": "#ff595e" }, "titleTextColor": { "value": "#121708" } }, "schema": { "additionalProperties": false, "description": "Describes custom error page properties.", "properties": { "background": { "additionalProperties": false, "description": "Bundles data for the background color.", "properties": { "value": { "description": "The value of background color in RGB.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "backgroundBottom": { "additionalProperties": false, "description": "Bundles data for the background color.", "properties": { "value": { "description": "The value of background color in RGB.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "backgroundTop": { "additionalProperties": false, "description": "Bundles data for the background color.", "properties": { "value": { "description": "The value of background color in RGB.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "categoryTextColor": { "additionalProperties": false, "description": "Lists the category text color properties.", "properties": { "value": { "description": "The color of the category text of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "categoryTextFontDecoration": { "additionalProperties": false, "description": "Lists the category text font decoration properties.", "properties": { "value": { "description": "The `font-decoration` of the category text of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "categoryTextFontFamily": { "additionalProperties": false, "description": "Lists the category text font family properties.", "properties": { "value": { "description": "The `font-family` of the category text of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "categoryTextFontItalic": { "additionalProperties": false, "description": "Lists the category text italic font properties.", "properties": { "value": { "description": "The category text in italic.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "categoryTextFontSize": { "additionalProperties": false, "description": "Lists `font-size` CSS properties for the category text of the custom page.", "properties": { "value": { "description": "The `font-size` of the category text of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "categoryTextFontWeight": { "additionalProperties": false, "description": "Lists the category text `font-weight` properties.", "properties": { "value": { "description": "The `font-weight` of the category text of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "contactMail": { "additionalProperties": false, "description": "Lists contact email properties.", "properties": { "value": { "description": "Email info of contact on custom error page.", "type": "string" } }, "required": [ "value" ], "type": "object" }, "contactPhone": { "additionalProperties": false, "description": "Lists contact phone properties.", "properties": { "value": { "description": "Phone number of contact on custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "contactPhoneText": { "additionalProperties": false, "description": "Lists contact phone text properties.", "properties": { "value": { "description": "Phone number of contact for receiving text on custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "contactTextColor": { "additionalProperties": false, "description": "Sets the contact's `text-color` CSS property.", "properties": { "value": { "description": "Color of the text describing contact info.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "contactTicket": { "additionalProperties": false, "description": "Lists contact ticket properties.", "properties": { "value": { "description": "Ticket for the custom error page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "contactTicketUrl": { "additionalProperties": false, "description": "Lists contact ticket URL properties.", "properties": { "value": { "description": "URL of the contact ticket.", "type": "string" } }, "required": [ "value" ], "type": "object" }, "corner": { "additionalProperties": false, "description": "Lists page corner text object.", "properties": { "value": { "description": "The corner text of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the object's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "explanationTextColor": { "additionalProperties": false, "description": "Lists custom page explanation text color properties.", "properties": { "value": { "description": "Color of the explanation text on custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "logo": { "additionalProperties": false, "description": "The logo displayed on custom error page.", "properties": { "value": { "description": "The URL identifier of the logo used in custom error page.", "type": "string" } }, "required": [ "value" ], "type": "object" }, "messageArea": { "additionalProperties": false, "description": "Lists custom page message area properties.", "properties": { "value": { "description": "The message on the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this object's last modification. If the object hasn't been modified since creation, the value matches `createdDate`.", "format": "date-time", "readOnly": true, "type": "string" }, "reasonTextColor": { "additionalProperties": false, "description": "Lists reason text color properties.", "properties": { "value": { "description": "The color of the reason text of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "reasonTextFontDecoration": { "additionalProperties": false, "description": "Lists reason text font decoration properties.", "properties": { "value": { "description": "The `font-decoration` of the reason text of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "reasonTextFontFamily": { "additionalProperties": false, "description": "Lists reason text font family properties.", "properties": { "value": { "description": "The `font-family` of the reason text of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "reasonTextFontItalic": { "additionalProperties": false, "description": "Lists reason text italic font properties.", "properties": { "value": { "description": "The reason text in italic.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "reasonTextFontSize": { "additionalProperties": false, "description": "Lists reason text font size properties.", "properties": { "value": { "description": "The `font-size` of the reason text of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "reasonTextFontWeight": { "additionalProperties": false, "description": "Lists reason text font weight properties.", "properties": { "value": { "description": "The `font-weight` of the reason text of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "title": { "additionalProperties": false, "description": "Lists custom error page properties.", "properties": { "value": { "description": "The title of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "titleFontSize": { "additionalProperties": false, "description": "Lists the custom page title font size properties.", "properties": { "value": { "description": "The `font-size` of the title of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "titleTextColor": { "additionalProperties": false, "description": "Lists the custom page title text color properties.", "properties": { "value": { "description": "The color of the title text of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "titleTextFontDecoration": { "additionalProperties": false, "description": "Lists the custom page title text font decoration properties.", "properties": { "value": { "description": "The `font-decoration` of the title of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "titleTextFontFamily": { "additionalProperties": false, "description": "Lists the custom page title text font family properties.", "properties": { "value": { "description": "The `font-family` of the title of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "titleTextFontItalic": { "additionalProperties": false, "description": "Lists the custom page title text italic font properties.", "properties": { "value": { "description": "The title in italic.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "titleTextFontWeight": { "additionalProperties": false, "description": "Lists the custom page title font weight properties.", "properties": { "value": { "description": "The `font-weight` of the title of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" } }, "required": [ "title", "backgroundTop", "contactMail", "contactPhone", "contactTextColor", "contactTicket", "createdDate", "explanationTextColor", "logo", "titleTextColor" ], "type": "object", "x-akamai": { "file-path": "schemas/custom-error-page.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get a custom error page", "tags": [ "Custom error pages" ] }, "put": { "description": "Updates the custom error page details.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-custom-error-page" }, "operationId": "put-custom-error-page", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "backgroundTop": { "value": "#D7D7D7" }, "contactMail": { "value": "jane@doe.com" }, "contactPhone": { "value": "800-555-1212" }, "contactTextColor": { "value": "#7f04ff" }, "contactTicket": { "value": "false" }, "explanationTextColor": { "value": "#808080" }, "logo": { "value": "url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGAAAAA8CAYAAACZ1L+0AAAgAElEQVR4Xkycd5RkVfXvPzffyrlz7umenBNDziAgiooBAUVFQB8KqGD8gQHMgZ9ZogRBlCQ552GYnHumcw5VXTlX3fBWleut9e7qtfqvut3n7HP23t+wSzivQ7ObAzKiIrBxWzdTMxla29zIksLE8QVESaS9tZmmzi7SsSl01csTT+9gImFSqsJQooANCILA5rDCsaSBZYNh2xQtGxOQRIG1rTpBVaBaMtk9X6Vq2awMyJy/PsjLA0n8TRLLwxGW9rdi5bM0d3Tw75ffp+AoMTFlMrFgoAVFTBNi0yayBJYJtg3tbonek1SO7ysT9oh4e2X8HmgICLT5XexMl1nIVNmytIWDR+dw+CCkCTgkCRuZ0ekC03MmkiLQ0i5RrkKbW2E8apCdq7I8KBHqVBmdLJOXgBmbatkm4hFxWCJlw2K+YmIXwahCR0QkpGkMTJdwKQK9YQebN/QyOD3F/HyB2UyVhaqFXQBhY0ixz90YYmAmi9Oj8d6BNJ/6UBOKCIcPJuq/16xpoaE1gmoKKJLKgy8fY8d4io7mZsrZPDMLMURBwC+LJA2LSm1XAAOB2k/tWeWVKRs2qgRHs7WwwIaAzAUnhnj5eAZNa0S38mxa6Wb46DxnnbeRD2bG2b5njlzUJuOwqZoCxbj13xf+f8/S5QqpnEA6VkFzCfhaJRpaRLobRLodEgfKFpJbxKuKxNMmLh0imogbHUEWGBvJMjFvkXdDc0DEsCA+a1Is2ISDItF5k83LVRZEG68uoM1IzObKLHGoOESV7EKZwWSZjGUTz1ps6NNJxA2yWYuegMxpaxrJlaoMLGShZFEL+1zBYGbRQlgVkO0z1oZ4Ye8iRQNEC9b1Oomny4xGq3QHZTSHwsr+AC0BL7Pzee7/YJ6+tia+ff3V9K7dzLdu/DY79+6ntjW1rbUQ6reitvlLm/yURY1MdJGyaeKRROZrKwSanSKbVnlpbNnAkbEo89EFlkXyjC2UWbvGyzv7M2TyFq3NIqmSzfy0hSDY2P8vqoCmCazZqDE1XsUybTIZm9YVMsvWyCxmLTo0ESUoMB2zWJwxaWlXWBvxMZnLUiyYhIIKkbzGu5NZUpJFT6eMmLOZOlwhWYI1y1RGMgbtAZF0FQKGQCigkluo0CQruGSJiZkSpmmTsK16ZpBdAu0+BVdFZOPydgq5ApPRJMWKSdghIYs2sarBkXEDYUuDYi/v9PGvvXEqpo0sgE8VcckCc3kTvypSMaEzKHHGujCposYLQ1muuuRcPnTxx0hlC0yPDfPo3++hXC7i84VZtqSDLUu7SFfAodrsmC6yJqyQzecYn4wyMDnN8ckFvD6Rm67/Jpdd9SUWJ47ztRu/g2UuEMtFic8YzGdNOhokdLdAYsKiULUxRMiU7fopqoWxrUWlu0VB8usMjmUINgsEOySCAZlk3sSVsYl4JY7nTRILJh/Z3Eq2UGI0lSGLhVmxWSNqbJ8vYgnQ0C8hztlMTRgE3BLtEY2D8RL+oAi1vx+3CCCimwLtjbV8BOl07VSDu5bSFIFo3qBiQMSh09/VxHsHxsnlTCJ+maYGjUq1ymLRIJG3EJZ5Fdvnltg9V64vSBdtFFmgWLbrKaR2lhXAKQmcs8JDb2szOxeVerDWdTWyrdfPCe025VySt48m2HjCVkqCk2R8EaNi8a/3x7jm5BYaI17GYnmyZYvndwzyvQvbKQpOXhspM5CW0SSJ4alZurtb2fHSU8wlTdwNIp1NEkNHjPoJk2WRTMnEMGwUUURXoHOlilqycHa5GZ3KsPRsjSa/Rqji4fholKWWg9lCmSG3jdOwOakjzK5MhsRsGaqgKNCBwKGcRbBVrKcca9GqpwfVLyIIkIqatcyBXa69A4IukXZdpWAbNCgSJdHCKoJu1V+JWhTIe20cVZlo3MAMWAQMkZBbQ9ElYoUCsgj5go1w0+kN9h/ejtbThlkLow2iCFbtTf/fIwqwsUGhu7ebX193DkdHorT5NdwujX0f7GLfRI4lq1cSbgyjiTb5TI5dRyfYfXyOq09fguT1UbFsFrNVdh0cpE0scmaHQvualURNN0PzRQ6OLbJmSYQ7H3oeo3YauySESZtk0cIwQZWEeh3RRPC4BXSXgKaLtDa5yYQNMt4KTid0tgRozTcxuTBBYbxYL9z6aRGEeG3Tq6Q0jUqyTDpVZT5dokkXGM9adHWrONwKR4fzxKZMWpsk9ICAaQtYll2vCS1BkWZdRDMF9LyMYZqURQt3WqMiVRFtAbkAsYJBJKBhllXSch7TYRIUZJy6SrVqkrIqhE0nwtG/f9r+4u2vsGMojuwVMWuF0ilQjtv1YPy/R5RsNnXprFu/hZ9cthVJlOuRyowe4d3RPO1tzSQsjVffPcJMIkvGEBiLJijlC0QCXrYsacYolVnV38KZ6zvZc3CY+MAkpmZx5QXrKFsiTreTWAWu/snDNLcJKBXw5wVUh4jbIeFUJGzbAtXG61bqp7NsgOx3kvBkSclVnLqC1+NFKal4TIvJaILoosG287YSm56mUi4jRhTyc1UyRoXFTJpWn5vhVBZPSCVXNjl8qERteV4VXD6Rig1NIQnVBS5DQJdsREQ8RRXNFvAaGnYWpoppWpxeGtwuovN5dLeTbNGgkC9Sskq0d3sp5ksYFYGcWCCs+hAyR/9mxydmOeGKn1FwVKnkbTo2Kkzvr1JK29R6SsUlUFt3/3KZ6KjMB/f/gKA/TGJikFt/9xifO38lrxyOMXB8kh9+9UJC4UZ+/+DLlHI5RheyxAUXF65v41On9HDPc3u488Uj/OILZ+GTKoS7ezlxfX+tj8WIjzJnBvnTQ/dTiWdwSgqaYaB6ZDy6hq5qeHQoyCYWBtVChZxtUtAMcp0CtmDjcbpxigqFjEGHM0h8IcqCp0xTqInFbJbEdBZTraVaB4upAtNTVc5aH8aHwGvzSdwRgX07KjgDQj3VaJZNpFNGMCHsVRBtq56iC4aNLyZilA1aXA2EVBfzmVk000ObP4hgiMQLeQx0ivkcFkWKlkE1Wcbl17HdVTILJkJ26O82ls41P/omeX+CyXEDX4tEet5kep9Rz7frT9JwN8kEm0R2vFhieXc337/oQxiHD3DlHz/grpsvorGzGwJt/On+J1lcTLCxK8xcKs9CqkSjS6Ej4qSxMcRpJ64lGo0zfPQIPW6T+549ylc+tRGrYz2DRwewfAFe/89/yCYMUCQcokVri4I/qGDVWjhdpGRatLY2k4zNkzeqzEsF5GaRkt9GLSkoloNyyaLXtYTBiSHm7Qxlh0CDU0dcEJiq3cp+lcVohXjGwq8L5OZgWZcLU7f4YCRPoF0i5BYQina9O2z2C+QsqJRsnN5aZRTwFmysgo0aE3HqGo0eJ0E5iCYoVEolomYclxpCLFuUczmqFQuXriDUGhtHiWylgPDKM5fYy9rW8dr7j7K7OMvO3RUCNSDhE5FTUJFtIi0KzS0BdE3nnTencIYkvtHxEd55+gN2lbz84qZPI4U6+c29z1IuZSE+xWfPWs2e4zMMTKbZtCTIB4MzvD8Sw+1y8+vbrqfLK0Amys///DidDovTP34huw4eIpueJzk8RUlQESwRwSrT0uYCxcQnq4TCYRQBNHeAaHwKUZFIVgxi7iQxPU+lYOMUnZSKJuuDmxmYOUyMFCnZpkNy0JB3M1KKI/cplKsGqZxJKmmRjlmU8jbLu1UqDgstLFFIW8wPGwiqQNArYGoCfr9Qb3X9ARFnmXqjISzaiBK0iE663T4iio+5RJJhaZGI7qZJilBIG5jFIl6vRiKbId9UQpJA+NKdPluq2AQ0ATHsYGQkj88v0h7xIQsBspOTlCWLUFeIsOlnLLNIJlnk1NzJNHj9/ODJAf7+oy9TMTV2TRZwVFMceutF8uUKo1OL9DV5WL+ii+HJKJ/44lUs2XoRhfkBZLtManA3z7z8Aef0iLhau9i7MElmfhTFrOX62mnLYksWZdnAXanldJlIcwuWajM0M0zBZeFUHVQqVaJCgXlHnnzRpFVxISDhljwYSpWpTIz5rEWrotHqcFOWKhTlKjNmpQ6ckkkLM2vjcwv4nSLOIKQtgfFjBmbBxuUVKNSaEg2WrFYoTpo4HSJyBUzRIpWxGd5eweEX+dDyMGrJQHXZFJ0mDlEkXPHilrwIRhWXplF0VJhf7iBTTSFc/XufXanYyIrI0tY2LNOgmE9RqVbQnQrpfLle7Fy6QFhuJexqI5Lcisss4BZsfvDAG3z1Mx/i32/s5zOf/BiPP/AAl335yxx65JdYuTyqIvPGeIUvXXcV6aLJfAGee/VNPnH6OiqJWX779Afcfc2pvLRjgI9efAqGNc/Y2ABFqYRQKBN0+LF1FacSwF2pURsVJsxZ0kqeoiWSyxZxWTJZqVivBYHagvVWVN3JVHmWxXSOvGDV19KS1+v/z4KcRihp5BST2WyZYq5W1EVU4b80R16GimFTyUOjW6Bo2+Qt6hSFQ4HVAZFgk0ZVd5Kfz6C6ROJTFYQ0rF3Zj6WUELwxRIcHIW8hpw20pIxYNSkXyzj9PsYbDZKODMLlP/LYwUaVhkAQTXIxNDtO2C8hShrVjIBZLlOWqvjRWBVZx9bOT3PLd/7M1R/dxvuHRvB73Kxau4Y9g9OEGlrRq3nm5ufRx94hOZdG0DWcfgeODRfREAjh6V7Go3f/iR/eeCVf+MZP2dYbYk1PA21tYQ5MFvj4uZsZHtvOaGYMo5wmqHsRxQCi4oBSDkutMCnMs961hJ0Lg8TFDE6vTLFQQUXGazlpa+gjLAdZKEwxkBplJFUgEtTotGpAMk3Ra7OYLmEItZ5boJC3UHQboQSiLZISTOKLFo0hiZAskS0KDMXL9VtZWLBoaRdZ0+vDr+vMVxLIzlrwRJrlNsq6i/zwFEVHDrlRRC5BtWyhFcCXVclLBhWXygwFsoaF8PMHO+ykWMa0RSRqxaJMqMlFMl3GzHsRpBReUWCF0M8ZG65iPObhpSceZTZv4ysuMju7QGDpFkbmFjnnlPWsCwm8/NB9NIV0ArkCVUFmQRQZKzj51NduZHBoBMnpp8sn8uXv3ckvL9/Ar148zjM3n8n3HzvMd67/HC4zxfH8fhZyg/iVAFRlcnKJpBJFJ0DOk6NZCDOeO4Ipqig13FEq41B1upxL8NsNVAtFFq1hLM3LQjJB2UqTzdhEUxUqtkCwwUehWKQvGEaYczKenULpNihmbQTTQnAKNRYRv+Go0zKDiRK2JFCJmrgdIuFWla1NDSS0BHHTwGNJBEMdLKSnSc6VaAzqWD6rzqXpCQlDtjGqZQq6SBmRgmHUsYbws4d77dlSAqdHxLYF7KpJwOEkNpXDUgQEWyToCnCqdx3rN9zI40+8TEdHG3+9+yFuPL+HQzsP4Np0ES+9+G/8YonVJ5zB/OtvstSVp5yzcOswmLVJWAorLzibR556C0mBVWu2ok/v56ytXXzh7j28+8+fc9nN/8ttN3yB/o4QxfxRDi68jqq5sNQS8WqUlJZBMkVklxvLqmLZFVRJw4n8XwLQNOp0gaJ6sUsqyeQUaVlEFAUEy2JouEzZkHDbIvFsCS1qs6zXj7Pdi1WRWfTMUq7a2KZFqR4ICIZ1rJKG6NWIZpNU8hZWycARkIjoTgpGHqdfRFNrTKiEUTQRDIuI7kBUgxi6RK48jy3bWLaFaGv1Lk6STGTTRLj3mZPsmdIshUoGQxaRBZNSyUaXJSRJwUMIHY1Pr7geTe9l974BVp90Js/e/RuCLoWXnniCQLAZx/ItTAzuYnI6x41bIijxIXIpE0WGiZRJ2xnn89sXdnHuGhnLtwpd9vDmi89yxUUncHwuwUVfvJmf/Pr3XHXRqWw9cTN2+hB75p9Gs1QK7jwLhUkQbGRJRHD6yZQzFK1cfc8DmhelWqRaqTBTsFE0UAQJp60QXSzWT3WDw890Ks1c0sCf/y+SrpQsSglo36Sx6DDRFIH5mInuEWhUHAgYSKKCZPvIaHl0RaJqGjhdAqlMHsm063ggEpFJJWv0vI1bEXDULo9h09zQjZXLkgnl65SOYVUJepooGllkE6LZHMKvnl5l59JRTF1A10MUqkmKteLn9uBQeshXFmkR/Hx85TcQXb08/uQLnHjq6aQmjmJWi1z5le/wrfVukobKlbf+jBuv/x4XBLJsWhfGLhvk82VS6TL37MyRbm7n3nv/xLe/fgv9xjTvp0WuuPTDhFpb6dtyFo888i/OP20zrZ0dKIUhto89xGJ1hKxdwIGGO1NAMQMUfA5yzhRzpTTlAqxQ4OiiBTJkkla9i3PW1uMWaZS8VGct8lhk5RxCQsfMO7DsDAv5Gn2t0NTlZyGXYDJR21wRy7bZ3NpLRHZTIUvSKZNllga5i+m5IVzNSj0wai7PgmyhOQRSs1b9c10NCoZoUS6DLUlotoiiyKSzeZweAY8jQkXIo5lOkrkkwu+fXGKTNcg7pBpWI10qUSpb9V467G0ik1/khOYzOGv5tZQNnT/9/i8cHZ9iYnKKDcv7SS1G6a1McEKHG0nzEp1dZEmDRseaZdiVCoZRYeroIHsH86R8TZx71kaO7dxF1azwz1Gbr1z3ecbmkrT0r+K+e+7lc5+4iM0b1hLx5Hlr6j4OLL5bJ+r8qodwxSCeKZNx2VQdBkYtZdrQKzSSThdgsYQbgahdJiGYdNbAlBaCfI3Pkah6SlQyNtWShLPkwNZ0PJ4m0voiI7FhkmkDq6ZrOCVaw2EarSUg5ag4ZGLyOLoYpCrZZHJTzI8UCQdEbJeMUxCwDYtsxcYry1Q8EtVyCdWEgNdDvlREEDRksYAoCURzFmZZwLAshF8/3GK7hAaychXJsolWo8SzBh2uIJYtoKFywdpr6O34KIYlMzcxxI9/9FNamyOce/o2cvkS87tepEstEJaqWPk0vpZmfA0tSKpeV8eS00MsjE5RUT24gyEGxhfYnxI588MX89ahCd587wOy+QLJXIHPXnQ23/3+t7GzYxzNfsDzg/fi0QRCTgmfqSDbXtJqgZiZI5qo4QCBpc4GnNEQpcUYbodOVigQFeJ1FUu3PaiCgGaFERUVVW1kJDeNs4aOxSIerYOiVWHRmMLraMZVS5u6Qk4ogOSiJGRRVSex1DwOJQhugVwxQbVs0OxspEKcYixDOB+i3GRg5/LMO0zyeRtZhYhXpZytYsoyLsGoq3iFGu1s2AiKhPCLe1faDnegHlVLVKjIGRAdBIouvJqfqlrlws134PesoLg4yfR0lP2HD+Lzh9i2aTVP//sx+iMaMwd2cXq3g4nBMTpWrcAdaawrMrYgkRgbZfbYESIdjYznVPbN5lE7V9HQ3MGZZ59Jpljlf376OwJymdt//jOc/giF6ABH5t7j3ZEHMNUiVUwCThG3rZIwKsgeF4VsjlqzEpT9eMwIyaF5dMFJ3lMiP5dEE2V03USKOPB4PQTzjdihFmbtBVwOAcnOYltlxKqTklKudzkeuYdKJc1MfhRBd5JL1/BGjnxaoMPlY8pMkihXiTgEPJoLW6igeERUvOQrWfL5Em4ZcrZQ3+SagtftF5kp2oSaRRyaE1HUEHMGhUwV4bo7Gm2Px41uGDQGu5iShzEqJt3lCAk5QWPLei5Zdzuy5KFayGNaNgsLUZ555gX8TpXB48fIZTJ8bbWBR1NJ50q09PWjeQPYlolplFkYOk5ibp6GsItkqshBfQnTRpDTN/axfzSKoqo89/yrfP+Wr7F66ykouptiZpa9A8/x1PZf0NOg4nS6cZkW2bzBrJUn0tdHdHqKklFAl8GPk2YjTIvdRkaJEpF0FDVCsRrDVgXMSgUkJ5YiMpwbQtJkXLq/Tp55NYGstMhsNo1d8dEoe0BOUHBJFKJ5qloVS42gGTppw2B4YYQOrwKSVde4PbWWsyRSqpSpaStyFbJ2tV6IXSUZpWBTYxFTullvRb3+YL2rqmTzCBd9y233Nek06kEaHG28W9hLedFiW0MvO0ujrGo+mU9u/CaKpdT1xqpRu14l/v3UCyzEk/QEFbo8sFSO4XE5yKXSNPT01pls06giYpFbXGRwcJL2iINkIs0TUxKjGYGvX3sFz7+1mx37Bjhr8wo+/qlLaWzvRVI1ZFnm6LEnGZj/B2KpgqsgEhWzeDSF44kopiHQ1hpgJpOiUKjSEWnDWxN154qEGjXCto8os0i6jaZ4KclFFHcY3TRYYI6sVaKCiYcgQYeb+cIMedsgWPLhtHyUnAnEuBNDUnG5K8RyVXSPh8MzE8zMFehp0slmazVHRvBY9dRkTUGLQ0P1eTBFA6lqE9BdpItl4maFAhUiegDFa5I30+haGOGrvwna/f4mJBR8Qphd1SN0F4JozkZei+9ha89JbGv/MP1NWymkMlSrFeYW4vVoP/jw4zQ2txMSMnyoT8UjG+yLGqxYtx5XJcrCzAxVFFp0i3i2jK6qDExEMRv6qUoqj799iB07dvE/N3yR7p5umtu78QdDZNIJ3B43peIsg0P3cdAYoFPtRBTzOMRmEtkJ9EUFvUXFROTQ+Aw+ICxFcFYrrGruI1kUeHd8hkafh1NWNFKQFbYfm62njUhklJhSqKtcJUXD4aiQMstUKlm6XGvRbRdzxkEqaQPJ5UAXK3Xp0uWo4QU3hbEspbzATGKaBp8bV4OHqqOEjlTnryJikJFcjLjloK29hebxEm4xwgH3KKbTS6vWQjhfxnYZCF/9VcCu9cjuQDMeU2XfwiBnezdxTI4xlJ6knFG5ZP0nWBLYQtjfRCqVRXW5SSTSDA8NMzI0yLr+NoTkJJVElEVvH9WDuzi7u4FyTX1Kp3h8JsflV13G+DtPs1CzYkR6mY4XODw0Rtjn5tJLLmTllm11pSgZmyMU8BGdGkMwDaafe4jGlgAVWWM+Y3PGlh6efOcY6VyFr1yyoQ6+3n7vKC1NAR59d5RrL1jFB4MLVDU3l5zaz/j0IocHJjlr20pe3TnI2wMxAn4n1354LX6XSDGTxhSrFDSFV3YeYfdskZAucv4WBdFnslhOkzcyKIqEoqiUHR6kvE78cIxsKkNwlYTocFEolZieTVEWYW1/C2VZpFw1ySXLVI5lmcsbBNcJpMZMeh0+ej0Rkk4D4Zd3L7MVb5B0Yp4GPcKe2AAXtVzC9tK7HBlewIOPK0/9Kt5KBH+4hWSmQCZbINLQUNdoo4spRg/swimb9AQFWrZezD8ee5Il7z2Fs1zmj2aIO37+Y0qTRyhnoyiNvew8OEZLZzd+rxd/OFT3FOXy/wUrUyMjLG0LUKzaDOzbizw/zsL4KOdtaqGk+dE8PiJBJ1+9632+ct5yTtu2jHKpws6D47g9LvYMzPCZc1bwvXu388kzV7JtXSfFTJaXXzvAhz+0iUdeOsBThxfpDupcffFGOtrD2Kk4mtdHdCHBUy/v40vXfBjNF6B47Ah4vbz89nH2TiU5cWMDa9aGyBWjTAzOc2zOYFmbiqNRZLY6TbRUwLRKBHweKlqOatKgUPTjtn3k5AWkiI3HlKiYVt0A4MCL8JuHemxJ8aFXBXyEOBY9QId/I0erx8jnSkSkFgJmGwFxHauX9VC1RAzVxQe7j3Jg/0EuPP809u8b4PRtK5kdOkzJklm57TSeefhB5sbHuO5732b4+CRvvfYShUyGL37+Ug5OZlm3aQPRhRjpZIplfZ1U8mkUh4v0+DHKU8M4G1s4NDBJcHpfjV0gli9w1roGZgpOzjihj73H5/jRs4M89p0P1Tuc+bkY9781zmdP7EDx+8nEU3z9od385gsns7K/hdT0NHpNqtRk7vjzizi8Hs7p9/Gd/4zw9++cS7gpwr1/eIxtZ5zAyg3L69qxlU7y1PO7eWTnNPfd8dl6WrSrZSb3HEZ26DS1RCgWq4zPJnlu5xQrlzhwrptmQZ3BUBUU24FUqvFpfmwljaz58RerxErTJCjT4O9DuOehdXaumiZdyOEuqei6j1QNuSlpFBz4y04KGR3zWANnX3AO/mAD8VyFocHjRONJpqM5gh6NwSOHWbl6OQ0BL5qqECsaxGJx+tsaKWYz6A6daCLDWDTPquV9NDY34/F6oVxiSX8Pk6OjdReZUCqQ2vc+wwfeR1B1tvS6eWH7NOlKlZsvauLwgkBHa4hwU5jfvTRBJODhcxesAUHk9d3DPLFzhls/s4lQ2Me9j7/P2+M5br3iRHrbA1AsYVkWlsPJnQ++zdJmN1ZikYsvOxMzm+WW25/gS1+6iJXrlmFMjzF4bIIfPn2UX15zDu09LXWfU+02PfzEdg5PZep0fG9nmOXLOlje00QsnuTlHYO09Cr4u/KMlBZxNGnoWhCpkMEuWXjlEAvKKGmxJubUUtBfOu1qLI9QAwllCYceZlqOo4R1Ot29WBUVK6+SOt5B0C2wckk7i+NDZLQQE9EcE2NDdLa1kTckXnnzPU5Z24OlOjk2NIqq68iiSH9bhLd3H0F2eDn3vHNwiDYOVWPF8qWoqoKmO0hHZxBzCYToGNLUQQaz4Cyn2NCts/94mh1DKW4618tgQmbVylZEzc1Ussw9O2L87OrTycYXyVYlfvDA+5y1eQmXf3Rr3VRwx12vcWg+z02XbmXT6jaEUhnR5WZsYIg/P7mH+alp/v6H68nOTHHBTY/y0l+vQ7HK2Lkktz3wAY0NQb72uXMxEvPMZSr8+IH3sAWRK07r56Qty5E9PkqZFOmFGOPzGTas6617lg4PTDGnpCj15evcz2w0hluysQWVI/E4Td0qhayF8I2f+G0lpiNX8tiyzGy5jOARWd7fQVukgcH0EH2uLex+qorb72Vl2EJSXew5PMbYbILmtgYmF4uItZZTkrji85dxcP9hvL4gnb2dvPLCK7REPBiCzKNPv057WysfOec0xEKyLtj4V2wgOzGOR9MJuQSk2UE8doK39h+v35SAEaNUzHNwJMeZK1SOzFRZu76TTN6mtTXAo7sSXH7eKkRZ5qW3j3D6iSv54v++wR9vOI9gU6xmPsAAACAASURBVBgjleTW+95hf8zgqxes5aLTV2AVCliSyOe/fS/VbJZH7/8uQ4cHufvBl/j57V+hNDVGPLrAHU8d4zdfOx9ZtMjOz3DtXXuIFkr842tnE4n466ai+eND9drj6egGRcUsFZkcHOPNg7N0uuBAVsPZapLrHsYVVBlZTJFM2kSCYn0Nwtd+GLCV6SphWadYgahdoqWnCVdEJy3WVP0il/k+zuvbFzkyneDcDd0cPXQMkSqT8QLelmaq+Tx+nxe37qB37RYaarKhUaFczNZBncsX5MiBA7z3zJN0hTyE/F7mcjZFU2Npox+nUaCxqxM5s4Dk8BEsDjFRVPCaUWSnF93MMTebpK3BSbZQweH1UVIchFwSB+YNVvU00trVwu7j81iIjMxlSBRNvn7VOdilEuP79vOrl8YYSJt8+9Mnce7mHjAtfvHHfzKeKPHH//kszzz3LutW9tDRv4RMbJHb/vwi1156En1djRjFAj+86yUWMwV+eNlmQgEP8fkoNbNSoLO7bmg7ODDFy3snUYslQh6VRp+GO+ChrauNBq/K6EyUhyePEDo9SSJdxYpZhMNehJt/FrTNxQptqp/FhRKViFTnqRedFaQGmdP1TZwcOJGFosh3f/sIZ564hqXNLsYmFsjlC3hbO5GsKp3dnQwcOICteQiEG8lXRYrFbN2HU04lceejeCq10gNvHs8RcjjYKOfx9SxFFQzk9By+phY0hw7BVsqLoxiihlqN0eAWmZ6I4tPF/7rGdCcNHWFmEyaWbXJkusBnPnICs/EC37x/B7+5+mTuf24fN37xApxOjfTYMEOjUR7eF2U8B/fedAEiNrH4IgOTcS46fS13P/gCV3/+4jpifv71/SzrbKBvRQ+JiXH++OwBHJrGDZefAbkUyYUFRM2BKxRiamKWPYfGKJYtNvQEaetoJFaRKRXLLMzMc+DYDDPpIql8ha5mP97lIqWehTqBt1jzLt/2swZ7MlFgk6+FWNWsI0SlUiQqW+Rkk1tXfxGt6sbX2MKX/+dvFFG45ZqPM3TgAOOzMYJOgc2nnkXFNNmzd4AlXWEeevY9Xtt9DK8q89GVAfpDLrxBX92SmE2VuWyNC8WoUg6spjBxkKbW9jpno+WiOPtPJLMwg+hzEovnkM0c/a1OyokYiXSFsE/BF3LjaWzk1f0xNrU7GZrIsfXUVeAJ8e0/vIQ74OX/fHQzv/vHu9z+9Y+QypW48S+vc+W6ILe9McsZy5o5eWmAai7BOeefRimf59d3vch3v34JA0fHCHrdtDb6yRfK/OD+d1jml7n6yx+lOHoczetBDjYyeXyYJ57fy+b+IMcnkxRrZGJJ5MB8FqdocdPFK1jR18TU2ByWJLEQTXDCyWtILCzy1vgco31TCG06wm2/aLArokWX3EPSKiEulEnGE2i9TrANruz5DPlcmaauPp55ax8/vf95LrnwbD56ykr+9fRrnHPGVjIVibnpKdavW8lf//kCjz//Nudt7OFjJy3FaeV448AcFHKsa5Rp1iw0wWQqblCoqrR6JHTRAH87gco4sqbzbKyBc/o19k7kWRKWaNQKlFIpUikDt0emo8mBq7WV2/41zA1nNuFvbkbUnKDqHNlziNtenuesjV187Mx1BBQDNdjIjb98ksvP6OPoZJKHds3y8Y0Rpsdj/PDbn+WJl/dg57OsXb8CD2Uagw5e++A4bw3EuWBrLyetbsc0DUSnu94JHfzgEPuPTNcDG8sUWcyUCLgVTl3fzZrlHbS0BLEKOUYPHeHYYJS+tf2kihUefW+U1HySk5cFOPn0XvY1xRDuvK3ZnqpmsV0hgqEQsfkoEWczQVunTZPpazgJKkXCDWFmMjbf+tUD6G4/N139KUaHhog0RuqDGm1d3Tzx/Bvc9/DjXLCln2s/cSoTo+OMTy3QqpZo94rYuRTVqlHP2zMLJU5slHC7VJySiag760MXbqXEU6M661oU9sc1LlwqEY9lcUsl4kkDzSmztMOFo6GB7z89waYWnY+duQJBVjELWcZn0xwYTnDH9gXu/z/nsG7zWqxKiUee3l4fCjl3QztX/vplLj1lCYvxHNdc9RF++8CLXHZSO816hYW5KH97Y4rBeIk/ffMS2hv9WIbJ5EKa48Oz7Nk7SixfRRJNVndGaI04WN/bgL8pVPcY5XMFwg6BufEJ0qkssq7zzP4oiqazYWkDXSGVQ8emOWNNI2LAifD9m/22prtJlAvEZBOHw1GnAFrUCJ/tPZNC0Yvf46xP0Ci+dh577i0eemEHn/3Y+Zywtp9gYzOVqs2f73mIwYEBTt64lI+eu5VdOw7ilwo0qXlkq0w1myaerfDb12Msd5uc2azUZxH8XoGaLcapiXhbm1DLCfZOW4wkbZZEVDb1+xgeTuLVq5QqNdVLZUmLgu4P8atX5hiOF7nnq9tAdVAoFBk6PEJni5+bnpjAFEX+ceeNCDUxPJvh+l/9h+svXMk3/vIqP7r+YkYnF+nrbOTo0DQnNxZwKfCRO3dyYn+E33zjEgTbZmYmyU8e2slcukC6XKFBhZ9cvpm+1UtrxiUsQWRyPMojLxyoj8d87NQu5iZjDEzn6G52MDid4/KPb6n7RHd9cJw3945z09Vn4nI5uPvx7QjfvMZrp0QLvabWKzJBh0ZRgHBZ54YLb+H9vcfYsHop77/3ARtO2EK0IHLptT/glK0buf7aK2hsaOTVV99gYmqKkEfntG0bKMTnID2DLlvYlSLFYpGHXjvG1OQiZzZCAAh4JIJ+mXKpRqeB063i8WgkchXMqsieqEG3B/oaJIbnqrgcIgGXTLwssaRRxhUJ88SeGL97Y45Xb1yHHgxiyG5u+OObfPPcNv6xZ5EnjiR46TdX09LahOgK8Ps/P4pVyPL4O8f4xIe2srq/m5GRMVrUIj6K3PzYYdZ3e7nj8ydhVwxu/8deXhpM0hLQ+NI5K+lrctPssJmMlxmcSjKeKiPki7R5ZVav7qx3NQc+OEI8XaKtI0JXswfZG2LngTEGj8+wojfIiSevqXNE377nHY6OJxBuv6bRLgYlFAOyHo2gC+bzJdrlMNed+z1+8odH+D+fv5ixo8fp6O1EdAZ49PHneOzV3fz6pz/A43IxPDiIbFc49eRtFBZGsAuLWJUi2VyRXQOT/OuNo2yM2JzdIZOanEdVZVxuFanm/cREqzmiJLluet03WsBV49llnYBaM1SJJJMGoiaxpElibFGir8OJpmu8dizNDY+N8OYN62loj2Crbm5/9AArW3SWt3r59H2HuOPzZ/DxT36kPrczPz7O/977DEGHwPapPOduWUlrow9naordRyb4565pHv/6RhKpEj/61wCHomXO7Aty9RndRDNVxtMm08kS8+kcfo8Lv22wrcdJoLGBVCpNOV9lebefpiY/gsPNe7tGGBqapy3iYuu2FYRbWqiWi/zivtd4ec80azo9CL/9RpOdztg4ZY2CW6LQWEWxLU73n8SJ267ga7f8kvPPO4UTV3aSSyfxNXdRFl1cc+P3+dbXr6Ozt5/Y1DD9S3uRjSJGMUuhXOadXUf56Z//SToe5+lbP4xbtogf2o9VzFMV1Lq24A15kMq1Ib+akdAkV7F443AWTRbZ2u9HE6qk8ia6Q2Imb7Opx8lk1KC/N4CkqRwYjHPZA8P888plrNmyou5Ee/i5XewbTfH9y9bx1T9sx+Fz8dCffwi6i2oxyyN/e5D+djefv/M1zti6mp72RlYF4JcPv8XFmzroUkrc8PQoiarBzeuCrOlv4Iyz1qL5G7AUnaopYhll7FIeiilefGuQpw9E2dwToD+ssKK/leaONg4fHuWJN49xYrtG5+qVLFvVX+MeeOXdg/ztsZ3sS5Z54eZTEP76g5W2QxLwO9wUa9eLSZSigw+v/jJN3SvZvecod//7dX7xP1/HLmWwanZxfxN/f+hfrFq7FofLy+plnXVrI4LEu+/u5K5/PM3BfQf4xKlL+ew56/FJBQrzU5Sj05TSBUqCA49DoFqu1ocnPHptVMjgqYMlNjbYFESVsC7idkmMRKv0tescnqpy2movIzMVVvb5kRxOjozGuPS+Qf73wnbOO38joupgLF7hil+/yF+uO5OR0Xl+9/oIL99/K9ViCUHWiE6PYxdiXHnH02xa2UNrRxuNmsFfHn+HKze38rs3RylWTe76VB8nr2lmMCHxz/enSS1mCGgypiDhVqEtqNPd4kGomZwkBaNaS50GbrHK5hNW8+wbRxmZjuOuteIXbKCpraWOMa76yeMUi2W+ftFKTljdivCTP/fanryEYFYJ2h7S4gLrW07GIW6gb+1qLNXLL3/xZzqXLuXskzeiGAUUj59YssD07CIbtm2tO9OqtsAzTz7H9nffqRtyLzxtDS5dxUjNIxeilGMzZOfmSMTLlCRnfV7KqdYUkQJm2WA4WiWfreBSJGRdxa3VHMgq7x4psmWVj9H5EietcDMxV2J5jQtSdI7PZLjsr/u5/fxOLjhvHZInjOAKcNWPH0UVLc5aFuFnzx7l5ftuRXIH+PVv7uI7N30ROznFF3/0AP5gEFlW8Xld7Nh1kBM7vTy8a5IfntfF0haNv29fZO9oso5keyJuNnQFOf+U5cjeIFotfWpS/UA+8tQORF3jxNUddRa1u7+b6clp7n1iF20+jSuvOAfTsvjpPa+wZzjOR7a08cWPbcNMRRH+8r9LbNWhkk0mkHQJnxLm/BWfIT2XJtK1DMnhZzGZ44bv/Jwrv3AFm1Z2o6oaZVMglsjSvWxFXax46dX3aFGzOF0OIn4numxTTs5j5JMsTk9hTR0jF12sixc167mnNisVL9HiMajkSuw4lKenQWYsY7Oqy1EfQ6qJvTPRCppHI5c32dDvJZ4q09PpQ3G767MHl/zhIDef3sqlH92GGGhB1L38/pHX+NOzezm9v4PXjgzz+t9uIdy9jAuuvIULN/dxw43X8fd/PMED/3qJT37iYt7duR+zWKgreCd0e2nzqdy9fZavbApyyaldBLr7mZua49f/Ocrbw2lkSaA96MIlw4e2dHHW2jYWxqfQGtsQKgV6lvbUDQm33/k0l5+3gq6VK9h/6Djfu+ddLt/azCc/ejJWOookKwh//fsS22P7wTJQLYXTln8GpVrBiM1x7MgUfZu3IvpbiaUK3HnPv1i3eRPnnbKBcrGIKTto7u4nU/OAxidJTQ3VC6lXLNSxg1DJItkG5WyGzOgA0yNJHJFAzXKJYhv1tk+wSiQXy2TSBoIksjMhcPGKmou5Ju8qeB1wJAo13TrkstgxWOC0jc0EIgEmoyk+/seD/PjD/axa1kr3qrUowVYOHjrGxTf/jUKliltXefXuW2nrW86VX/sRR48P88xdP2Y2VeJL37yDqy77GG9s38vqpR1MDw3R7zI5Np0gXqzUb3WmbNb17ZrrrWqa9IcdrO5ppC3kp2pUmInlOHlpGJcqU1V0Ni6JEE8W6F/azq/veZGPnbaUaCLPY9tH0EWZ2649t653G4sTSOE2hN/+pc12Z3Wcip/NzeuJhJrqdgq7UCI9cZS3xmDrtk2U0CjYKq+9tZNl6zbQHtKo2VnaV5+AXM2SGdrJB++8R1dbBK9cwqFKVEt5SqkkVj7F+JERDs1VUVSdjrBOk7vmwayp/FUyqQpG2WJH1KDJo7GhXUFQZBarMr2NCm8cL3HWukA9KLc/OcVXzuukp7+DWMHk0p+/wY8+uQ5bd7FuyxaaOnrI5XN86dt38uLeYXRF5tW7fsDyDZu5+8Gn+N6v7uazZ27gc1/6HF/+5u10dLaTzWRZuWIJk8MjhBSDtw9OMZcvsq7Fw6Y2NxeuaWF5VwjN6cTp0pFDbdhGhdrclqDoPPP6fjb1hXh7zzinrWlicirOxo393P7ge0Qkk90TaZZ3h/n6Z05FtM26P8k2qswmKwi//0O7LSQsgqrOecvOR/SEoGyTPr4bSw/w3ntHeGnK5PILtnDo+AxbTzuRqimzb2ia9UvbWHPqRWilKIW5IYb3vlcnp1SzzNK+lnqOrKQTHDs0xAPbk2zrcnP6Sk993kym5q6oEl8oYNTGPz0irw6VWRJSWN/nBo+HeCxD35IQ7xzKcNraEFVB4dYnx7jloh66ViylaBhc89tXuHhjN5MFm1LJ4sc/vplqucy///MS3/jtP+szXa/c82P61mzg3ff3cOl1360DrId+913ufezlOqWsSBJt7W1MjQ0RMDI8u3uMz29o5NqPrECzq9Qm9hSHE1vW6htnV8rI4WYo5euFPRFbrJ/6p/bMsbrdR9CpsHZ5M996cA9vHpjmhZ98jOYGL6KkYpv17w+oA8ob7nwe4dU/fduuieAt8hySUEAwoLQYZWIySt7WMEyL7z10AEuTOX1JiGVrVtO6ZCljk9OMz6e4+rqv4CgtUJncRSU+z65D4xyayvLOQJSQz0G3X2eZu8KWXg8KBkZt3LMMc7ESpWSp/tUFtSnEvx4tcUGrSn+bi/4OB6bDgVU18TWFeHHHAh85eym2JHPLXe/zg8u30r6khwIy1/3sCS46YSkv7Z9iYGyal+65DW9DG+/sPMAnrr8Djyrx4v130LN8HW9s381VN95KJl/knp/dwpMvv0skHGQ+mmDLllpaLZCeH+edD47wt2tPpRJf4OE3j7N3Lke6ZNPu0VgS0Zkr2ViGTcEWWR+UaQy52dCh8Ze35/j0tg40VSbU3MTn/vA6a1sC/O7mS+u4aGFsmKbWJmzVyZ1P7eVvz+xC2P/Iz+0GKY7mKGMXi1AokEkXGByZZWg2R0dnE2/tGuG10XSdwt3c28Tmk7aSL5ZxaSKnn30uQTlLcXwv2cV4vd92KgKlXJbJY6OEPf+d702kDRaT5frXEHhrc7WSgWjapIoWL/zfGs49uq6yTOO/ffbe534/OSf3mvSSttAboFQGcUSBAjoFpyIWHaozxUHHcSFrcFxLEcvSEWd0vCDjiDozDhWtYMV6QSyUcrVQLr1ATZumSZqkuZ0kJ2efc/Z971nfVyf/ZK2s5Kyd/b3f+z7v+z7Pc9bhLzujmChU8nE2rs4Ry6clujKTbTx6YIi//8ClWIrG333rAJ+6bh1b3nsVlq/y1Qcfo6+zyCMHjzE0PsOvvn0nay56O0dODHPrp7+E2Wqy7/u76O1fyf6nnuG3Tx1k0wUredumC9m97zluvnkbTz71LGs3XURci1CdmeLpg8/xyfcM8J1HXpA0moFilNuu6GHjuj5K5TxnT5/l1FiVlpbih8+Msr4U5ZoNBb739CRXb+yQtc1Mlbn/d0f4+d3bKRXS4LssLBlMLNh8/7EXODo6yxYBQ08+dEdYoipnKVrbcppDhzHbLuboiVOMj5xl5cq3MHVunrlag9H5Ojdcs5l3XPl2wtkJOZtvLhno5hy+3SCSzBOJqPi2xdLIIK5lcm66QSEOsURUklFbdZNGrUV98bwCc89Jm/f2xzlnePKFvuuiLIlskmS5QiGjMdbQ2X/oNJ+69d1SpXjLV/ZxaV+R++7+JK1A41s/3iep6cdG5njmyBD/+bkPc+X1N1A1HD7z+ft47egb7Pnidi5e1YYSS+PHctQnBnGXqtjNJrVYNwvZlWiZMmbTwLYsThw/QknzePh3L9AeafHNmwdIx0M5BdBzFdRyL0OvvEJ7QefVkRY92Qjf+8Ux1LhCLhVjeV+Znx6eZnVHig9edxnJpPDeaHDP937LmTmDjd05tr5jgIjiosz/+jOhN/IGYc9FzC15dA6sx4wUJe/9ud/8hC1XrEf3TLTAQvFMAtsisEy5MxWqP8EKCMTCWYuhRzVqlkJK6ngVVCXED8Xe3UYLhGDZYmG2xXw9ZKbmc3zGZV1ZRVVgohayYkWGFcsLUsjQs2KZ1Ii/OGbjez7v27KZsQWHj9zzY1Z1Fnjo63fSCOP8+4/2UkkEPHt8nBePn+bGzau4d9cXaBFn90/2sPXylfTHmsQSCfRkjlCL4zcWMGYnmJmdx1bjRCprMSNJqbJZnBxhaPAkDV9hYmqeL+94J8bwcVTFpqeSx3YDZg2fh545y+BUjXu3LqejmGDva1VeGl7EFoPMclqSFd7/nvXMLJnMLPnMLhqMjU/T25ZB0VSm5oW2IUCZ/c7VYajHaUzNcDK5nouvv4WG8D2Yfo2ENUKwOA2hT2C28Jp1KdkXhch3XayWJccSMVVwHj0sy0GNiq4QUukYQocZhqGkqfuekP+0mDhrMVULqBo+vUWVxVbAyXmfQjnB+rUlymL8q6pyRtMMYvzm+TNc9rYBNl36Vk7PNPjErh9IJLH3u3cTxFPsf/oQ5UKCp149w+5fPi6Z0P9x7x2sXd5D1prklNtNX18v1XNjkp1x7lyVwHMpqCaKHiFV6qDYO4AeT1KvzdOszTNfneXAU89JRLepPcnX973Exu40Vw7k+dmB05xphORLBeqOS69q0deWQijUDk8Ykt4uxuo9pSztbTleOTnJxHxddr9RNUIhrtFRTNNZzNHVU0GZ//nHQ99sYgwPcnxe4ah2EZdvfivukX1csiyCbyxKZQpOQ8pvxMMLWrXrifgUIjcV3/VlGy4cKKwghmOaxHUFNxAjBh9NV2jUTIIgwvSUScOKSBcVx4XnRhz8qMoFl3ShaEl6uvMkxV6gkGep6TF4eoYrrthEobOHP82Y/NN9P8BtGuz55mcp963CaNoYhsGjTx7iRw89iud5bL3sQh749DUMvTHImJviSz96ks/vuJbrLqlgGks0vDg1y+XpPx5jahFWbdiAFgQUihkyuSxdhQS6FtBTjpPwGkyfeoNH9h7mYx+7hkh1VN7q1KpLUHMVHvn29yVk/eVZldGJaWqmLfuGSiHHmp6iBBl9XSXaKhVymRSBa5FK5+hatpzq4hLKwt47w7lXD0q+jJ/MM5JazyuDVW7MjVDSTZRQRK/Qjgk3FUXy/XXFxxdOKpqK5/o4oS5JuyLH244io91xfbRQyHJCAqG7CgPpkzM750vDDaFHe23cRUnrjIc669ZUyLV1SE+dC/pLmIFGIR2jXC6hpYs4aLx2cpyvPPAwtmXywN238ZbVGySGn11q8dPHnuD3B56Xaesfdmxj5/b3s+cXv+bVw0e44x8/Sk9bijbdRG9MEQYuSugTuhaRdAGl0IniWoRm8zy+12OE9XmCxoK8/Z7tMHP6DJFIBD+VJdQSJFIpmotLlJM+Og6tTC83/NvTDE4uSKZfIZukVMrTUSlTKubo62ynkk1gN+tyLBEoKosNB2Vm//2hOXoYv7VEtr2HM2aB7977AJ/bkkEjoNnwyZcSKLEovmPjhRE8z5fcF8GSUyIqaiIuD0Lgb8fxMFse9SVH8mcE+0BEhPDPcZwAxxZs5QhzjVAqLRfzKRpqlEvX9yMU0q+fGOVtG9eQimt09nTzlv4VjE1MYLVaHDk1wX89+gRNo85dH7uBzuVrOTMyypmJGWr1BocOv07NaLLjr69jYWaaJw4d5dorNvON++6hrRjHGz5Ea3GGuFDUNWcJrCZqvh1FiaCoGmEQyImlOJhQRBohVr1OPF/ArU7IcYXvOkQSWRYNi8mxKZavX0ch6RM26+wdVvnWYy9LSZJYV1YNS6p4xFcxk2J5ex6rvkQ6naV7WTctX0F59Yk9YUF3aE6+SS4a8Oz+Y+QnX6GvW5dRKqacwXnxIZFYjFAR7iVRXMeXEeF5gWRMm0JvFVdpNj1sO2C+6mI6gbyuTqAQEbXDD0knI2RSEY6MepQuu5D/PjBIT3uRrkobWq7IzNQUc3M13n35JtZefKmcO50ancSaGScRjTA8epaL+yrSxatr+cD5G9hYZPTMCAEBLdPlheMjHB9f5NxinZ3bruf6q97F5VddjX3qADWlQH7xGJpTwxNCLtuQEFEQb0PfRU0VBclOgg1x87zApzp2hnL/KtlU+laLaCItCVnG+CmODjWxIxprBvppW76CRw6eQCn10LI8HvrZXtZs2MjOHbewdmAFUS3gndfcxES1RndnJw/ffw/K7l23hwMbL8NoGLz8h99zwcJR2tIWOeHoEfhENB2j4ZEuprAsD9uPSDKsMHSyTY/FRVdWc0HLMKzzUS5mPTFNoe4ELJlCqioO6vwhtndmUDN5jHgKP6bKLlM4comoER1yf2eero4K8UQCLRZDUVXq9RaBK17SecmpsCZIpLOEgqIiKL2+L3euiURUDspef/1NpucXOfzmMA3L56orNnPDtm1Ux09RdzTWLS/hDr+IeW4Yz6gTy+VQ42kCNXbeDicI0JNJ9GhCWo0dOWvyvg9+hCf+sJ+hc/N85OabeObFQ3zzwd1yPHHX7Tu49cMfkDfpyd8/zvY7drH9hvfyoWs3c/OndqHHYty18yZ2bruKk4OnuOb2L9O0XUq5DMoPv3BbmGjvZ+TUKNlXf8WmHoVYIY4nHHEiEfEsEnoZDZeZeZsT4zZzhkdWV+TNEIoZMaiyRF5HkU5QqqbQFJ2iEkFNxFizqot0JiP8y1jT3ykF0LrYgOmaXJSLzyjk0tJdUZh/+aGQowo6uE4ipsu6IxSIQrOWEI57oSIE7rLuiJ9pUV0KQ9rKJeLJFMLQwKib+IHHzPQMjx88TKqjn462HMdPjvDB911JMPUm584MM1u3CTJdLHo6a1cuJ14os//gs6iKwm23fxzLqLF1+w7u/9q/EI34fOKzu9j74L/KW791510S5X30xqv53M5taNEYh19/g+3//A35/A9+4TZOD/6Jr+55hvV9nTz0xb9heGKWW+79XywBQUX4rO7sCFOtBltXamxcKTRPKqoeYfJcg8kph6OLHmOGRyyi0JtViasRjtZcJgyXK4txXOGjJg4hhLO2j5KIcvOVq+np7mJ2waCns4yiqLTL7wqBH0ghnVBPisKeymRkh63oUZpGi2p1iWJF9ALCmSRHJp2mOl8jFo8ijlhspHRdIRYTN9NkfmGJZFTM5jXKYuUnFImRqISDqVyW2kKNE+SFMwAABHpJREFUxZrBhQP91FsuTx54lpEpg98d/CPD0zPnYTXCGUdj88XrZFQeO3mGLe+6nLphcNPWa/nAzs9wx99+iJnZWXbve5I7b91K6Dq8/KcRnn99kIHuEp/e9k6JCP944iwP7z8s/9cbN6/Eajk8fmyM9b0lPvlXm/naIy8wOrck60JSaJ43RGPhlq4ob70kx5gb4+WhOlsuv5BA02na8KtDJ1AjKmv6Opk8N8MbZ2eludLkoilRqPBuS8c02vMJ+jvyVNraWNFTYll3hXw+T3tXp9yXCsZCJpuTq0cR4b5lS7uWrKB8hyGu6xJRREpSsG0HNB3Ldv9ch6Jowk0wVGSqEd2qa1nSIkbVomjRKIagR2YSckI5PbdEPpcjms3JFytgtNM00aMRDr10hPv+59dM1xryVv3/VzKqs2HVMlb1daPpOq1WSxpElfIZXnpziGIqxtD4LL2VPNcKduDKfhbm5kln0xIdKpEI89UqyZQYO3hC4i2NT8TGTOYG38NxbKKJjCzuAoKmElGU7e2psDuvYrWXSBfLRKMqxbY2me87OypU56pU2tsoFfNEoklsu8Ufnj/G2OgYvu1QzsXo6a5QyGVZ1tuFGomQy2YwbUdCNYEu8tkUzZYpybvJZArPsbBtV1IzRNcm6IgCv4v9pLQUi8YkehAdcRBGcBxH3iLRaYtakExn8V0b13ZkDpb2SYFPIGCiqCdRjWg0yuzsNJWOLnmQuWKJiZER+fN0NsP4dJXB4XFefvM01/3FejZesJJUMoUai0vli21aJFMpuQMQqE9XQ/lsoqmMZdIyrzcbTfk/iemq64dYrSaFfI4wIqRKtjxI0ZQZjaa0axPeRq4byINxHZd8IYty/epyuHFtL4Gi0dneTt1okkjH6eoo45ieXErk8lkuWN1P3TBlfrUaTbnKC3A5OThCVFcpl4vSyna+bmH7IaFRo9Deft51MS4KZIxCsSitbywR4HhSLNEyWmQLOWKxOGarJaNEiABFWhJpRijSE7k0drMl042YJgqtgd00pJWC6wUkhc5AmOeZpjx0yzkvDhQobmJmUUZpTFPxfZ/evm4swyRTEGYdFpHA5ezwKJlinngyI9Pi5MQYejyLHk9QzCWlz5u4oVoyjmM6KJpGOpXEdWxpP6PHhRtiktr8vKxNvuMSyyTJxpPS9qdeN8hkUtRrS+ISS1HK0NAovu+g7L77o6FRb1JpL8mXX+lsp9V0SKWS0sAvFtNk6y9Yc+dtiMFXk6RiqkwnM9PTRGMqDaOFFouSiEbl7MdsNqUJn2VanJtbor1SwGhYmJZJd2e7zLuqrpNKpmV/IeCtKMG6phPRVJm7U3/++1JbGT/w5SZJpDLH80jEoxJ9aZpKPBHDalqS/KRqGka9IRuohPhsgSLC8Lzng67geD7pdBrTsmT2ET1FMhaXLzFQ45hLNfkcgmUtJFjidwXqE2lMzKQM22NpboZsOkkyLZbyKpbtkc1n8GyTRt0gkcrQatSlA6+YsDYbdfl5aHEp6c2kYrSWavL2/B+19USlgWbKjgAAAABJRU5ErkJggg==')" }, "title": { "value": "#ff595e" }, "titleTextColor": { "value": "#121708" } }, "schema": { "additionalProperties": false, "description": "Describes custom error page update properties.", "properties": { "backgroundTop": { "additionalProperties": false, "description": "Bundles data for the background color.", "properties": { "value": { "description": "The value of background color in RGB.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "contactMail": { "additionalProperties": false, "description": "Lists custom error page contact email update properties.", "properties": { "value": { "description": "Provides contact email info on custom error page.", "type": "string" } }, "required": [ "value" ], "type": "object" }, "contactPhone": { "additionalProperties": false, "description": "Lists custom error page contact phone update properties.", "properties": { "value": { "description": "Phone number of contact on custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "contactTextColor": { "additionalProperties": false, "description": "Lists custom error page contact text color update properties.", "properties": { "value": { "description": "Color of the text describing contact info.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "contactTicket": { "additionalProperties": false, "description": "Lists custom error page contact ticket update properties.", "properties": { "value": { "description": "Ticket for the custom error page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "explanationTextColor": { "additionalProperties": false, "description": "Lists custom error page explanation text color update properties.", "properties": { "value": { "description": "Color of the explanation text on custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "logo": { "additionalProperties": false, "description": "The logo displayed on custom error page.", "properties": { "value": { "description": "The URL identifier of the logo used in custom error pages.", "type": "string" } }, "required": [ "value" ], "type": "object" }, "title": { "additionalProperties": false, "description": "Lists custom error page title update properties.", "properties": { "value": { "description": "The title of the custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" }, "titleTextColor": { "additionalProperties": false, "description": "Lists custom error page title text color update properties.", "properties": { "value": { "description": "The color of the title text on custom page.", "minLength": 1, "type": "string" } }, "required": [ "value" ], "type": "object" } }, "required": [ "title", "backgroundTop", "contactMail", "contactPhone", "contactTextColor", "contactTicket", "explanationTextColor", "logo", "titleTextColor" ], "type": "object", "x-akamai": { "file-path": "schemas/custom-error-page-update.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Update a custom error page", "tags": [ "Custom error pages" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/custom-error-page.yaml", "path-info": "/configs/{configId}/custom-error-page" } }, "/configs/{configId}/deployments": { "post": { "description": "Creates a new configuration deployment.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-deployment" }, "operationId": "post-deployment", "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": { "comment": "Changes in this deployment: 3 Locations 1 Sub Locations 1 Policies 1 Custom Responses 1 Custom Lists 1 Other Changes", "created": { "customPatterns": [], "customlists": [ { "id": 170460 } ], "honeypots": [], "policies": [], "sites": [ { "id": 6840081 } ], "subLocations": [] }, "deleted": { "blacklists": [], "customPatterns": [], "customlists": [], "honeypots": [], "policies": [], "sites": [], "subLocations": [], "whitelists": [] }, "modified": { "customPatterns": [], "customlists": [], "globalSettings": { "id": 1 }, "honeypots": [ { "id": 87284 } ], "policies": [ { "id": 2480 } ], "sites": [ { "id": 5782867 }, { "id": 5563387 } ], "subLocations": [ { "id": 540 } ] } }, "schema": { "additionalProperties": false, "description": "Lists properties in a deployment POST request object.", "properties": { "comment": { "description": "Message that summarizes the deployment.", "minLength": 1, "type": "string" }, "created": { "additionalProperties": false, "description": "The deployment's set of newly created components.", "properties": { "blacklists": { "description": "The blocklists removed from the deployment.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "customPatterns": { "description": "The set of custom dictionary patterns in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "customlists": { "description": "The set of custom list IDs in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "globalSettings": { "additionalProperties": false, "description": "The global settings updated for the deployment.", "properties": { "id": { "description": "The unique ID for the global settings modified.", "minimum": 0, "type": "integer" } }, "type": "object" }, "honeypots": { "description": "Custom response IDs in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "policies": { "description": "Policy IDs in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "sites": { "description": "Site IDs in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "subLocations": { "description": "Sublocation IDs in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "whitelists": { "description": "The allowlists removed from the deployment.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "sites", "subLocations", "policies", "honeypots", "customlists", "customPatterns" ], "type": "object", "x-akamai": { "file-path": "schemas/deployment-post-crud-section.yaml" } }, "deleted": { "additionalProperties": false, "description": "The deployment's set of deleted components.", "properties": { "blacklists": { "description": "The blocklists removed from the deployment.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "customPatterns": { "description": "The set of custom dictionary patterns in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "customlists": { "description": "The set of custom list IDs in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "globalSettings": { "additionalProperties": false, "description": "The global settings updated for the deployment.", "properties": { "id": { "description": "The unique ID for the global settings modified.", "minimum": 0, "type": "integer" } }, "type": "object" }, "honeypots": { "description": "Custom response IDs in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "policies": { "description": "Policy IDs in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "sites": { "description": "Site IDs in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "subLocations": { "description": "Sublocation IDs in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "whitelists": { "description": "The allowlists removed from the deployment.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "sites", "subLocations", "policies", "honeypots", "customlists", "customPatterns" ], "type": "object", "x-akamai": { "file-path": "schemas/deployment-post-crud-section.yaml" } }, "modified": { "additionalProperties": false, "description": "The deployment's set of modified components.", "properties": { "blacklists": { "description": "The blocklists removed from the deployment.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "customPatterns": { "description": "The set of custom dictionary patterns in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "customlists": { "description": "The set of custom list IDs in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "globalSettings": { "additionalProperties": false, "description": "The global settings updated for the deployment.", "properties": { "id": { "description": "The unique ID for the global settings modified.", "minimum": 0, "type": "integer" } }, "type": "object" }, "honeypots": { "description": "Custom response IDs in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "policies": { "description": "Policy IDs in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "sites": { "description": "Site IDs in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "subLocations": { "description": "Sublocation IDs in the deployment.", "items": { "additionalProperties": false, "description": "Contains resource ID information.", "properties": { "id": { "description": "Unique identifier for the resource.", "minimum": 1, "type": "integer" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/resource-id-only.yaml" } }, "minItems": 0, "type": "array" }, "whitelists": { "description": "The allowlists removed from the deployment.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "sites", "subLocations", "policies", "honeypots", "customlists", "customPatterns" ], "type": "object", "x-akamai": { "file-path": "schemas/deployment-post-crud-section.yaml" } } }, "required": [ "created", "deleted", "modified", "comment" ], "type": "object", "x-akamai": { "file-path": "schemas/deployment-post-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Create a configuration deployment", "tags": [ "Deployment configuration" ] }, "get": { "description": "Returns a history of deployments for the current configuration.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-deployments" }, "operationId": "get-deployments", "parameters": [ { "description": "__Enum__ The deployment status to query. You can provide several comma-separated values. Refer to [Deployment status](https://techdocs.akamai.com/etp-config/reference/deployment-status) for more information.", "explode": false, "in": "query", "name": "deploymentStatuses", "required": true, "schema": { "enum": [ "CONTENT_EXTERNAL", "REVERTING", "STAGING", "PENDING", "RUNNING", "COMPLETED", "FAILED", "BUILDING", "ABORTED", "AUTO_RKS_ONLY" ], "example": "COMPLETED", "type": "string" }, "style": "form", "x-akamai": { "file-path": "parameters/deployment-query-params-deployment-statuses.yaml" } }, { "description": "Filters the deployment history results by `locationId`. You can provide several comma-separated integer values. Returns all matching records regardless of other query parameters used.", "explode": false, "in": "query", "name": "locationIds", "required": false, "schema": { "example": "6908808,12260589,16791107", "type": "string" }, "style": "form", "x-akamai": { "file-path": "parameters/deployment-query-params-location-id.yaml" } }, { "description": "Filters the deployment history results by `policyId`. You can provide several comma-separated values. Returns all matching records regardless of other query parameters used.", "explode": false, "in": "query", "name": "policyIds", "required": false, "schema": { "example": "676808, 1226999, 1679340", "type": "string" }, "style": "form", "x-akamai": { "file-path": "parameters/deployment-query-params-policy-id.yaml" } }, { "description": "The ISO 8601 timestamp of the start time for report data.", "in": "query", "name": "startDateTime", "required": false, "schema": { "example": "2020-08-03T03:07:00.000+0000", "type": "string" }, "x-akamai": { "file-path": "parameters/start-date-time-query.yaml" } }, { "description": "The ISO 8601 timestamp of the start time for report data.", "in": "query", "name": "endDateTime", "required": false, "schema": { "example": "2025-05-03T03:10:00.000+0000", "type": "string" }, "x-akamai": { "file-path": "parameters/end-date-time-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "changes": "{\"policies\":[\"Auto_Custom_Test_Policy_Delete\"]}", "comment": "System generated. Update policy 96694 for DNS FW", "deployedBy": "jkowalski", "endTime": "2025-04-28T10:30:37.812+00:00", "id": 204000001642339, "message": "Config :9497,RKS gen:21833,Nevada :44057,CAS :53250\n,RKS :115163", "progressPct": 100, "startTime": "2025-04-28T10:28:37.569+00:00", "status": "COMPLETED" }, { "changes": "{\"customlists\":[\"gctestlistsync_02\"]}", "comment": "System generated. New list for DNS FW: 65403", "deployedBy": "jperez", "endTime": "2025-04-30T10:35:05.817+00:00", "id": 204000001643997, "message": "Config :10036,RKS gen:20067,Nevada :45646,CAS :51235\n,RKS :294673", "progressPct": 100, "startTime": "2025-04-30T10:30:10.328+00:00", "status": "COMPLETED" } ], "schema": { "description": "Deployment details.", "items": { "additionalProperties": false, "description": "Deployment details.", "properties": { "changes": { "description": "The deployment configuration changes made, represented as a JSON-formatted string. ", "type": "string" }, "comment": { "description": "Deployment comment.", "minLength": 1, "type": "string" }, "deployedBy": { "description": "__Read-only__ User who initiated the deployment.", "minLength": 1, "readOnly": true, "type": "string" }, "endTime": { "description": "__Read-only__ The deployment's end time.", "format": "date-time", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the deployment.", "minimum": 1, "type": "integer" }, "message": { "description": "Deployment details.", "minLength": 1, "type": "string" }, "progressPct": { "description": "Indicates the deployment's progress as a percentage.", "maximum": 100, "minimum": 0, "type": "integer" }, "startTime": { "description": "__Read-only__ The deployment's start time.", "format": "date-time", "readOnly": true, "type": "string" }, "status": { "description": "Specifies the deployment status. Refer to [Deployment status](https://techdocs.akamai.com/etp-config/reference/deployment-status) for more information.", "enum": [ "CONTENT_EXTERNAL", "REVERTING", "STAGING", "PENDING", "RUNNING", "COMPLETED", "FAILED", "BUILDING", "AUTO_RKS_ONLY" ], "type": "string" } }, "required": [ "id", "status", "message", "comment", "startTime", "deployedBy", "progressPct" ], "type": "object", "x-akamai": { "file-path": "schemas/deployment-specific.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/etp-configuration-deployments-all.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List configuration deployments", "tags": [ "Deployment configuration" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/deployments.yaml", "path-info": "/configs/{configId}/deployments" } }, "/configs/{configId}/deployments/{configDeploymentId}": { "get": { "description": "Returns details of a specific configuration deployment.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-deployment" }, "operationId": "get-deployment", "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": { "comment": "Dynamic domain resolution changes", "deployedBy": "hgildong", "endTime": "2020-08-03T03:07:21.308+0000", "id": 101, "message": "Config :51RKS gen:185RKS :2076\nNevada :9117PAC :9959", "progressPct": 100, "startTime": "2020-08-03T03:07:01.617+0000", "status": "FAILED" }, "schema": { "additionalProperties": false, "description": "Deployment details.", "properties": { "comment": { "description": "User comment provided for deployment.", "minLength": 1, "type": "string" }, "deployedBy": { "description": "__Read-only__ User who initiated the deployment.", "minLength": 1, "readOnly": true, "type": "string" }, "endTime": { "description": "__Read-only__ ISO 8601 timestamp marking when the deployment completed.", "format": "date-time", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the deployment.", "minimum": 1, "type": "integer" }, "message": { "description": "Deployment details.", "minLength": 1, "type": "string" }, "progressPct": { "description": "Indicates the deployment progress in percentage.", "maximum": 100, "minimum": 0, "type": "integer" }, "startTime": { "description": "__Read-only__ Start time of the deployment.", "format": "date-time", "readOnly": true, "type": "string" }, "status": { "description": "Specifies deployment status. Refer to [Deployment status](https://techdocs.akamai.com/etp-config/reference/deployment-status) for more information.", "enum": [ "CONTENT_EXTERNAL", "REVERTING", "STAGING", "PENDING", "RUNNING", "COMPLETED", "FAILED", "BUILDING", "AUTO_RKS_ONLY" ], "type": "string" } }, "required": [ "comment", "deployedBy", "id", "message", "progressPct", "startTime", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/etp-configuration-deployment-specific.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get a configuration deployment", "tags": [ "Deployment configuration" ] }, "parameters": [ { "description": "A unique ID for the configuration deployment.", "in": "path", "name": "configDeploymentId", "required": true, "schema": { "example": 101, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-deployment-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/config-deployment.yaml", "path-info": "/configs/{configId}/deployments/{configDeploymentId}" } }, "/configs/{configId}/deployments/{configDeploymentId}/diff": { "get": { "description": "Provides details of deployment changes.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-deployment-diff" }, "operationId": "get-deployment-diff", "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": { "changes": [ { "changes": [ { "changeType": "Modified", "changes": [ { "changeType": "Modified", "changes": [ { "changeType": "Added", "detail": { "name": "192.0.2.94" } }, { "changeType": "Removed", "detail": { "name": "192.0.2.249" } } ], "detail": { "name": "Exit Point" } } ], "detail": { "id": 18217, "modifiedBy": "jperez", "modifiedDate": "2020-06-23T14:08:03.933+0000", "name": "DDNS" } } ], "deltaType": "sites" } ] }, "schema": { "additionalProperties": false, "description": "Contains deployment change details.", "properties": { "changes": { "description": "Deployment change details.", "items": { "additionalProperties": false, "properties": { "changes": { "description": "Lists deployment changes.", "items": { "additionalProperties": false, "properties": { "changeType": { "description": "The type of change, either `Created`, `Modified`, `Added`, or `Removed`.", "enum": [ "Created", "Modified", "Added", "Removed" ], "type": "string" }, "changes": { "description": "Nested deployment diff objects.", "items": { "additionalProperties": false, "properties": { "changeType": { "description": "The type of change, either `Created`, `Modified`, `Added`, or `Removed`.", "enum": [ "Created", "Modified", "Added", "Removed" ], "minLength": 1, "type": "string" }, "changes": { "description": "Nested deployment diff objects.", "items": { "additionalProperties": false, "properties": { "changeType": { "description": "The type of change, either `Created`, `Modified`, `Added`, or `Removed`.", "enum": [ "Created", "Modified", "Added", "Removed" ], "minLength": 1, "type": "string" }, "detail": { "additionalProperties": false, "description": "Describes the change details.", "properties": { "id": { "description": "Unique identifier for the change.", "minimum": 1, "type": "integer" }, "modifiedBy": { "description": "__Read-only__ User who made the change.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedDate": { "description": "__Read-only__ When the change occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the change.", "minLength": 1, "type": "string" }, "newValue": { "description": "The value after the change.", "minLength": 0, "type": "string" }, "oldValue": { "description": "The value before the change.", "minLength": 0, "type": "string" } }, "required": [ "name" ], "type": "object" } }, "required": [ "changeType", "detail" ], "type": "object" }, "minItems": 0, "type": "array" }, "detail": { "additionalProperties": false, "description": "Describes the change details.", "properties": { "id": { "description": "Unique identifier for the change.", "minimum": 1, "type": "integer" }, "modifiedBy": { "description": "User who made the change.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ When the change occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the change.", "minLength": 1, "type": "string" }, "newValue": { "description": "The value after the change.", "minLength": 0, "type": "string" }, "oldValue": { "description": "The value before the change.", "minLength": 0, "type": "string" } }, "required": [ "name" ], "type": "object" } }, "required": [ "changeType", "detail", "changes" ], "type": "object" }, "minItems": 0, "type": "array" }, "detail": { "additionalProperties": false, "description": "Describes the change details.", "properties": { "id": { "description": "A unique identifier for the change.", "minimum": 1, "type": "integer" }, "modifiedBy": { "description": "__Read-only__ User who made the modification.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedDate": { "description": "__Read-only__ Date of entity modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the change.", "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } }, "required": [ "changeType", "detail", "changes" ], "type": "object" }, "minItems": 0, "type": "array" }, "deltaType": { "description": "Name of entity type changed. Either `sites`, `policies`, `lists`, `subLocations`, `customLists`, or `global_settings`.", "enum": [ "sites", "policies", "lists", "subLocations", "customLists", "global_settings" ], "type": "string" } }, "required": [ "deltaType", "changes" ], "type": "object" }, "minItems": 0, "type": "array" } }, "required": [ "changes" ], "type": "object", "x-akamai": { "file-path": "schemas/deployment-diff-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List deployment changes", "tags": [ "Deployment changes" ] }, "parameters": [ { "description": "A unique ID for the configuration deployment.", "in": "path", "name": "configDeploymentId", "required": true, "schema": { "example": 101, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-deployment-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/diff.yaml", "path-info": "/configs/{configId}/deployments/{configDeploymentId}/diff" } }, "/configs/{configId}/dictionaries": { "post": { "description": "Creates a DLP dictionary.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-dictionary" }, "operationId": "post-dictionary", "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": { "aggressiveMode": false, "akamaiDefined": true, "createdBy": "jsmith", "createdDate": "2021-03-31T13:00:01.041+00:00", "id": 1242, "modifiedBy": "jperez", "modifiedDate": "2021-09-14T09:00:01.138+00:00", "name": "PCI DSS Universal", "patternDetails": [ { "description": "Specified quantity of both credit or debit card numbers and of associated phrases such as:-\n* \"csv\"\n* \"Expiry Date\"\n* \"Bankleitzahl\"\n* \"American Express\"\n* \"handelsbanken\"\n\nFor a definition of credit card numbers that are detected please see the CCL description for \"Credit card numbers [Universal]\".", "id": 13, "name": "Credit card numbers - with phrases [Universal]" }, { "description": "Credit, debit, travel, store or membership card numbers using a common bank identification numbering system. Such as:-\n* 16 digit card numbers (including MasterCard and VISA)\n* American Express\n* CUP (China Union Pay)\n* Diners Club\n* Ita\u00fa Unibanco\n* JCB\n* Maestro\n* Royal Bank of Canada\n* ScotiBank\n* Verve\n* magnetic track data containing card numbers\n\nCard numbers must conform to the following:-\n* Start with a \"3\", \"4\", \"5\" or \"6\" i.e. be a standard format ISO/IEC 7812 number with a Major Industry Identifier (MII) for 'Travel and entertainment', 'Banking and financial' or 'Merchandising and banking/financial'.\n* If not 16 digits then start with a recognised Issuer Identification Number (IIN)\n* Have an appropriate length for the card issuer\n* Either be contiguous or have an appropriate digit grouping for the issuer\n* Any digit groupings to be separated by a white space \" \", dash \"-\" or dash variant\n* Have a valid Luhn check digit\n* Must not appear to be part of a larger digit sequence\n\nNOTE: Card numbers used for other non-financial purposes but that use the same format as monetary cards will be detected as credit cards. This is because:- \n* These cards typically have high PII risk\n* Loyalty cards (etc.) often do have an actual financial value or financial consequence\n* Card issuers have been known to upgrade loyalty & travel cards to have a financial value", "id": 14, "name": "Credit card numbers [Universal]" }, { "description": "Card magnetic track 2 data according to the ISO/IEC 7813 specification.\n\nThis detection is included within the CCL \"Credit card numbers [Global]\". \nThis CCL is provided as an optional level of granularity.", "id": 128, "name": "Credit card magnetic track 2 [Universal]" }, { "description": "Card magnetic track 1 data according to the ISO/IEC 7813 specification.\n\nThis detection is included in the CCL \"Credit card numbers [Global]\". \nThis CCL is provided as an optional level of granularity.", "id": 127, "name": "Credit card magnetic track 1 [Universal]" } ], "patterns": [ 13, 14, 128, 127 ], "policies": [] }, "schema": { "additionalProperties": false, "description": "Lists parameters in the DLP dictionary object.", "properties": { "aggressiveMode": { "description": "Enables aggressive mode.", "type": "boolean" }, "akamaiDefined": { "description": "Indicates an Akamai-defined dictionary.", "type": "boolean" }, "createdBy": { "description": "__Read-only__ Name of the user who created this dictionary.", "minLength": 1, "readOnly": true, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the dictionary's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "Description of the dictionary.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ The unique identifier for the data loss protection (DLP) dictionary.", "minimum": 1, "readOnly": true, "type": "integer" }, "modifiedBy": { "description": "__Read-only__ Name of the user who most recently modified the dictionary.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking when this dictionary's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the dictionary.", "minLength": 1, "type": "string" }, "patternDetails": { "description": "The pattern details.", "items": { "additionalProperties": false, "description": "Lists DLP pattern detail properties.", "properties": { "description": { "description": "A description of the DLP pattern.", "minLength": 1, "type": "string" }, "id": { "description": "A unique identifier for the data loss protection (DLP) pattern.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the DLP pattern.", "minLength": 1, "type": "string" } }, "required": [ "name", "description", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/dlp-pattern-details.yaml" } }, "minItems": 0, "type": "array" }, "patterns": { "description": "The pattern ID.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "policies": { "description": "Lists the security policy assigned to a site. Configure the accepted use policy and set responses for known and suspected threats under specified categories.", "items": { "additionalProperties": false, "description": "The security policy to assign to a site. Configure the accepted use policy and set responses for known and suspected threats under the specified categories.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Marks a policy as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated administrators for the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks a policy as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "akamaiDefined": { "description": "Marks a policy as Akamai-defined.", "type": "boolean" }, "aupSettings": { "description": "Contains the acceptable use policy settings.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AUP category data.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "groups": { "description": "Groups users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Describes the operation settings on the AUP setting.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Lists user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "categoryId" ], "type": "object" }, "minItems": 0, "type": "array" }, "aupSource": { "description": "Name of acceptable use policy source for the policy.", "minLength": 1, "type": "string" }, "authPolicy": { "additionalProperties": false, "description": "Details of the authorization policy adopted for the policy.", "properties": { "Oidc": { "additionalProperties": false, "description": "Provides OpenID Connect (OIDC) provider and client details.", "properties": { "client": { "additionalProperties": false, "description": "Provides information about a client.", "properties": { "authUri": { "description": "URL for authorization.", "type": "string" }, "checkSessionUri": { "description": "URL to check if session is alive.", "type": "string" }, "clientId": { "description": "__Read-only__ A unique identifier for the client.", "minimum": 1, "readOnly": true, "type": "integer" }, "clientName": { "description": "Name of the client.", "minLength": 1, "type": "string" }, "endSessionUri": { "description": "URL for ending session.", "type": "string" }, "frontChannelLogoutUrl": { "description": "URLs for logout from front channel.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "grantTypes": { "description": "Client grant types.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "idpId": { "description": "__Read-only__ A unique identifier for the IDP for the OIDC.", "minLength": 1, "readOnly": true, "type": "string" }, "javascriptOrigins": { "description": "JavaScript origin locations.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "postLogoutUris": { "description": "URIs for post logout from client.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "redirectUris": { "description": "URLs for redirection.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "tokenUri": { "description": "URL for token.", "type": "string" }, "userUri": { "description": "URL for user information.", "type": "string" } }, "required": [ "authUri", "checkSessionUri", "clientId", "clientName", "endSessionUri", "frontChannelLogoutUrl", "grantTypes", "idpId", "javascriptOrigins", "postLogoutUris", "redirectUris", "tokenUri", "userUri" ], "type": "object" }, "provider": { "additionalProperties": false, "description": "Mapping of authorization policy URLs to OpenID Connect (OIDC) URLs.", "properties": { "authPolicyUrl": { "description": "The URL from the authorization policy.", "type": "string" }, "oidcUrl": { "description": "The URL for the OpenID Connect (OIDC).", "type": "string" } }, "required": [ "authPolicyUrl", "oidcUrl" ], "type": "object" } }, "required": [ "client", "provider" ], "type": "object" }, "allowUnauthenticated": { "description": "Allows unauthenticated users.", "type": "boolean" }, "enabled": { "description": "Enables an authorization policy.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the authorization policy.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpPreAuthConsent": { "description": "Indicates IDP pre-authorization consent.", "type": "boolean" }, "retryAuthForUnauthenticatedSessions": { "description": "The number of retries for an unauthenticated session.", "minimum": 0, "type": "integer" }, "sessionTtl": { "description": "The duration of a session.", "minimum": 0, "type": "integer" }, "userInfoRefreshTime": { "description": "__Read-only__ ISO 8601 timestamp marking the last user authentication refresh.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "Oidc", "enabled", "id", "idpPreAuthConsent", "allowUnauthenticated", "retryAuthForUnauthenticatedSessions", "sessionTtl", "userInfoRefreshTime" ], "type": "object" }, "authenticationMode": { "description": "Specifies the authentication mode. Either `REQUIRED`, `OPTIONAL`, or `NONE`.", "enum": [ "REQUIRED", "OPTIONAL", "NONE" ], "type": "string" }, "avcSettings": { "additionalProperties": false, "description": "Contains the AVC setting properties.", "properties": { "applicationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "categorySettings": { "description": "Lists the AVC category setting properties.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "Contains data for a category.", "properties": { "code": { "description": "The acceptable use policy categorization code.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The selected default action for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the category.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the category.", "minLength": 1, "type": "string" } }, "required": [ "name", "code", "defaultActionId", "deprecated", "id" ], "type": "object" }, "description": { "description": "Description for the category settings.", "minLength": 1, "type": "string" }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "Contains response data.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "description", "categoryId", "categoryInfo", "groups", "operationSettings", "response", "responseId", "responseOverrides", "users" ], "type": "object" }, "minItems": 0, "type": "array" }, "riskSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "applicationSettings", "categorySettings", "riskSettings" ], "type": "object" }, "basicSettings": { "additionalProperties": false, "description": "Contains the basic policy settings.", "properties": { "dnssec": { "description": "When enabled, provides DNS security.", "type": "boolean" }, "edns0ecs": { "description": "When enabled, optimizes CDN traffic using the `EDNS-Client-Subnet` extension.", "type": "boolean" }, "forwardProxyEnabled": { "description": "Enables the forward proxy.", "type": "boolean" }, "proxyEnabled": { "description": "Enables the proxy.", "type": "boolean" }, "safesearch": { "description": "Enables the safe search feature.", "type": "boolean" }, "trustXFF": { "description": "Enables trust of `X-Forwarded-For` headers.", "type": "boolean" } }, "required": [ "dnssec", "edns0ecs" ], "type": "object" }, "classifiers": { "additionalProperties": false, "description": "Contains classifier details for a policy.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis for a classifier.", "type": "boolean" }, "enabled": { "description": "Enables the classifier.", "type": "boolean" }, "name": { "description": "Name of the classifier.", "minLength": 1, "type": "string" }, "sizeExceedingAction": { "description": "The size exceeded action.", "minimum": 0, "type": "integer" }, "zdpEnabled": { "description": "Enables Zero-Day Phishing (ZDP) protection for a classifier.", "type": "boolean" } }, "required": [ "name", "dynamicAnalysisEnabled", "enabled", "sizeExceedingAction", "zdpEnabled" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this policy.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "customHeaders": { "description": "Lists the policy custom header settings.", "items": { "additionalProperties": false, "description": "Lists the policy custom header object properties.", "properties": { "customHeaderId": { "description": "__Read-only__ The custom header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "domains": { "description": "Lists the domains assigned the custom header.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "headerName": { "description": "Name of the custom header.", "minLength": 1, "type": "string" }, "headerValue": { "description": "Custom header value.", "minLength": 1, "type": "string" } }, "required": [ "customHeaderId", "domains", "headerName", "headerValue" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-custom-header.yaml" } }, "minItems": 0, "type": "array" }, "customRequestHeaders": { "additionalProperties": false, "description": "Lists the policy custom request header settings.", "properties": { "args": { "description": "Lists custom request header arguments.", "items": { "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ The custom request header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "target_domain": { "description": "The target domain for the custom request headers.", "minLength": 1, "type": "string" } }, "required": [ "args", "id", "target_domain" ], "type": "object" }, "description": { "description": "A description of the policy that you provide.", "minLength": 1, "type": "string" }, "dlpExceptions": { "additionalProperties": false, "description": "Lists the DLP exceptions for the policy.", "properties": { "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "groups", "users" ], "type": "object" }, "dlpSettings": { "description": "Data loss prevention (DLP) actions and details.", "items": { "additionalProperties": false, "properties": { "action": { "description": "Action ID for the data loss prevention (DLP) dictionary.", "minimum": 0, "type": "integer" }, "dictionaryId": { "description": "__Read-only__ A unique identifier for the DLP dictionary.", "minimum": 1, "readOnly": true, "type": "integer" }, "dictionaryName": { "description": "Name of the DLP dictionary.", "minLength": 1, "type": "string" }, "dictionarySource": { "description": "Name of the DLP dictionary source.", "minLength": 1, "type": "string" }, "patterns": { "description": "Data loss prevention (DLP) patterns to match.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "threshold": { "description": "The maximum number of DLP patterns to consider.", "minimum": 0, "type": "integer" } }, "required": [ "action", "dictionaryId", "dictionaryName", "dictionarySource", "patterns", "threshold" ], "type": "object" }, "minItems": 0, "type": "array" }, "fWaasSettings": { "description": "Lists firewall as a service settings.", "items": { "additionalProperties": false, "description": "Configures Firewall as service.", "properties": { "appIds": { "description": "Lists app IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "countryCodeInfo": { "description": "Lists country code info.", "items": { "additionalProperties": false, "description": "Specifies firewall as a service geolocation data.", "properties": { "alpha2Code": { "description": "The ISO 3166 two-letter code for the region.", "minLength": 1, "type": "string" }, "alpha3Code": { "description": "The ISO 3166 three-letter code for the region.", "minLength": 1, "type": "string" }, "countryName": { "description": "Name of the firewall service.", "minLength": 1, "type": "string" } }, "required": [ "countryName", "alpha2Code", "alpha3Code" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-geo-info.yaml" } }, "minItems": 0, "type": "array" }, "countryCodes": { "description": "Lists country codes.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "destinationIp": { "description": "Lists destination IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "enabled": { "description": "Enables the service.", "type": "boolean" }, "fWaaSId": { "description": "Unique identifier for the firewall as service.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the service.", "minLength": 1, "type": "string" }, "networkServiceIds": { "description": "Lists network service IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "networkServiceInfo": { "description": "Lists network service info details.", "items": { "additionalProperties": false, "description": "Contains firewall as a service information.", "properties": { "description": { "description": "Name of the firewall as a service.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ Unique identifier for the firewall service.", "minimum": 1, "readOnly": true, "type": "integer" }, "port": { "description": "The port used by the firewall service.", "minLength": 1, "type": "string" }, "protocol": { "description": "Indicates the protocol used by firewall service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "serviceName": { "description": "Name of the Firewall as a Service.", "minLength": 1, "type": "string" } }, "required": [ "description", "id", "serviceName", "port", "protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-info.yaml" } }, "minItems": 0, "type": "array" }, "nonWebAppInfo": { "description": "Lists non-web-app info.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "ports": { "description": "Lists ports.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "protocol": { "description": "Describes the protocol used by service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "rank": { "description": "Priority of the service.", "minimum": 0, "type": "integer" }, "responseId": { "description": "__Read-only__ ID of the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "sourceIp": { "description": "Lists source IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "type": { "description": "Specifies the service type, either `IP`, `APP`, `NETWORK_SERVICE`, `GEO`, or `DEFAULT`.", "enum": [ "IP", "APP", "NETWORK_SERVICE", "GEO", "DEFAULT" ], "type": "string" } }, "required": [ "name", "type", "fWaaSId", "rank", "enabled", "responseId", "sourceIp", "destinationIp", "ports", "protocol", "appIds", "countryCodes", "networkServiceIds", "networkServiceInfo", "countryCodeInfo", "nonWebAppInfo" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-settings.yaml" } }, "minItems": 0, "type": "array" }, "farmId": { "description": "__Read-only__ A unique identifier for policy's farm.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeSettings": { "description": "Lists the filetype settings for the policy.", "items": { "additionalProperties": false, "description": "Lists the file type setting parameters.", "properties": { "applyTo": { "description": "Lists policies to apply the file type settings to.", "minLength": 1, "type": "string" }, "fileTypeId": { "description": "__Read-only__ Identifies each file type.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeInfo": { "additionalProperties": false, "description": "Contains file type info properties.", "properties": { "category": { "description": "The file category.", "minLength": 1, "type": "string" }, "code": { "description": "The file's code.", "minLength": 1, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The file's default action ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the file.", "type": "boolean" }, "id": { "description": "__Read-only__ Lists the file ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The filename.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "category", "defaultActionId", "deprecated", "code" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-info.yaml" } }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "name": { "description": "Name of the file type.", "minLength": 1, "type": "string" }, "responseId": { "description": "__Read-only__ Lists the response ID for the file type setting.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Provides details about response.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseOverrides": { "description": "Contains the AVC response override details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "type": { "description": "Lists the file type.", "minLength": 1, "type": "string" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "type", "responseId", "fileTypeId", "users", "groups", "responseInfo", "responseOverrides", "fileTypeInfo", "applyTo" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-settings.yaml" } }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ A unique identifier for each policy. Use this value for a `policyId` parameter in subsequent operations.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpId": { "description": "__Read-only__ A unique identifier for the associated identity provider.", "minLength": 1, "readOnly": true, "type": "string" }, "ipaSettings": { "additionalProperties": false, "description": "Contains IPA settings.", "properties": { "blockOnUploadScanTimeout": { "description": "Blocks on upload scan timeout.", "type": "boolean" }, "blockUnscannableFiles": { "description": "Blocks unscannable files.", "type": "boolean" }, "enabled": { "description": "Enables IPA.", "type": "boolean" }, "randomCheck": { "description": "Enables random check for `ipaSettings`.", "type": "boolean" }, "zdp": { "description": "Enables Zero-Day Phishing (ZDP) protection.", "type": "boolean" } }, "required": [ "enabled", "randomCheck", "zdp" ], "type": "object" }, "modifiedBy": { "description": "Name of the user who most recently modified this policy.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the policy.", "minLength": 1, "type": "string" }, "originPorts": { "description": "Lists origin ports for a policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "originValidationFailActionId": { "description": "__Read-only__ A unique identifier for a validation fail action.", "minimum": 1, "readOnly": true, "type": "integer" }, "policyGeneralSettings": { "additionalProperties": false, "description": "Specifies the policy's general settings.", "properties": { "androidDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "aupMigrated": { "description": "Migrates acceptable use policy.", "type": "boolean" }, "avcEnabled": { "description": "Enables the AVC.", "type": "boolean" }, "blockBrokenTLS": { "description": "Blocks broken TLS traffic.", "type": "boolean" }, "bypassO365": { "description": "Bypasses Microsoft Office 365 traffic.", "type": "boolean" }, "chromeOSDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "classifyMigrated": { "description": "Migrates classify information.", "type": "boolean" }, "disableClient": { "description": "Disables the SIA client.", "type": "boolean" }, "disableInsecureCiphers": { "description": "Disables insecure ciphers.", "type": "boolean" }, "dotConfig": { "additionalProperties": false, "description": "Contains DNS over TLS configuration.", "properties": { "mode": { "description": "The DNS over TLS mode:\n- `ATTEMPT` always tries to use DOT and falls back to standard DNS when unavailable.\n- `REQUIRED` requires DOT and informs the client the device isn't protected.\n- `DISABLED` doesn't apply DOT to secure DNS traffic.", "enum": [ "ATTEMPT", "REQUIRED", "DISABLED" ], "type": "string" }, "port": { "description": "The assigned port for `dotConfig`.", "minimum": 0, "type": "integer" } }, "required": [ "mode", "port" ], "type": "object" }, "enableIPIntelligence": { "description": "Enables IP intelligence.", "type": "boolean" }, "etpClientMultiUserEnabled": { "description": "Enables multi-user on the SIA client.", "type": "boolean" }, "fwaasEnabled": { "description": "Enables Firewall as a Service.", "type": "boolean" }, "httpProxyOverride": { "description": "Represents HTTP proxy override priority.", "minimum": 0, "type": "integer" }, "iOSDefaultAction": { "description": "Specifies the default action on iOS devices.", "minimum": 0, "type": "integer" }, "idpUserInfoRetryInterval": { "description": "Specifies the retry interval value for IDP users.", "minimum": 0, "type": "integer" }, "ignoreLocalDNSResolvers": { "description": "Ignores local DNS resolution.", "type": "boolean" }, "localBreakoutForBypass": { "description": "Enables local breakout for bypass.", "type": "boolean" }, "proxyAuthEnabled": { "description": "Enables proxy authentication.", "type": "boolean" }, "wgExceptions": { "description": "Enables walled-garden exceptions.", "type": "boolean" } }, "type": "object" }, "proxyHostname": { "description": "Name of proxy host machine.", "type": "string" }, "riskyFileHandlingSettings": { "additionalProperties": false, "description": "Describes file handling settings.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis.", "type": "boolean" }, "hugeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for huge risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "largeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for large risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "hugeRiskyFileResponse", "largeRiskyFileResponse" ], "type": "object" }, "safeSearchSettings": { "additionalProperties": false, "description": "Contains safe search settings.", "properties": { "youtube": { "description": "Specifies the Youtube access policy, either `open`, `moderate`, or `strict`.", "enum": [ "open", "moderate", "strict" ], "type": "string" } }, "required": [ "youtube" ], "type": "object" }, "securitySettings": { "description": "Contains the policy security settings.", "items": { "additionalProperties": false, "description": "Contains the policy security settings.", "properties": { "confirmedGroups": { "description": "Confirmed groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "confirmedResponseId": { "description": "A unique identifier for the confirmed response.", "minimum": 1, "type": "integer" }, "confirmedResponseInfo": { "additionalProperties": false, "description": "Contains data about the confirmed response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the confirmed response info.", "minimum": 0, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the confirmed response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "confirmedUsers": { "description": "Confirmed users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "listId": { "description": "A unique identifier for the list.", "minimum": 1, "type": "integer" }, "listInfo": { "additionalProperties": false, "description": "List information.", "properties": { "categoryId": { "description": "The unique category ID.", "minimum": 1, "type": "integer" }, "id": { "description": "A unique identifier for the list info.", "minimum": 0, "type": "integer" }, "listType": { "description": "The list type. See [List types](https://techdocs.akamai.com/etp-config/reference/list-types) for details.", "enum": [ "AKAMAI", "TOP_LEVEL_DOMAIN", "WHITELIST", "FILEHASHLIST", "FILEHASH_BLOCK", "DOMAIN_IP_LIST", "URL_BLOCK", "URL_BYPASS" ], "type": "string" }, "name": { "description": "The name of the list info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "categoryId" ], "type": "object" }, "responseOverridesConfirmed": { "description": "Response overrides for confirmed response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "responseOverridesSuspected": { "description": "Response overrides for suspected response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "shouldNotifyConfirmed": { "description": "Send alert on confirmed list hit.", "type": "boolean" }, "shouldNotifySuspected": { "description": "Send alert on suspected list hit.", "type": "boolean" }, "suspectedGroups": { "description": "Suspected groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "suspectedResponseId": { "description": "A unique identifier for the suspected response.", "minimum": 1, "type": "integer" }, "suspectedResponseInfo": { "additionalProperties": false, "description": "Suspected response data.", "properties": { "id": { "description": "A unique identifier for the suspected response info.", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the suspected response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "suspectedUsers": { "description": "Suspected users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "listId", "confirmedResponseId", "shouldNotifyConfirmed", "shouldNotifySuspected" ], "type": "object", "x-akamai": { "file-path": "schemas/security-settings-info.yaml" } }, "minItems": 0, "type": "array" }, "sites": { "description": "Contains associated site IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "sitesInfo": { "description": "Contains data about associated sites.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the site.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the site.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "sublocationInfo": { "description": "Lists sublocation info.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id-name.yaml" } }, "minItems": 0, "type": "array" }, "sublocations": { "description": "Lists the sublocations configured for this policy.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "trafficLogging": { "additionalProperties": false, "description": "Provides details of traffic logging in different modes.", "properties": { "headers": { "additionalProperties": false, "description": "Contains header information for traffic.", "properties": { "request": { "additionalProperties": false, "description": "The request details in the header.", "properties": { "mode": { "description": "Request mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" }, "response": { "additionalProperties": false, "description": "The response details in the header.", "properties": { "mode": { "description": "Response mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" } }, "required": [ "request", "response" ], "type": "object" }, "mode": { "description": "The traffic logging mode. Either `full`, `url`, `path`, or `host`.", "enum": [ "full", "url", "path", "host" ], "type": "string" }, "url": { "additionalProperties": false, "description": "URL details of the traffic.", "properties": { "mode": { "description": "The URL mode used for traffic logging. Either `FULL`, `PATH`, or `HOST`.", "enum": [ "FULL", "PATH", "HOST" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } }, "required": [ "headers", "mode", "url" ], "type": "object" } }, "required": [ "description", "name", "aupSettings", "securitySettings" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-retrieve-specific.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "name", "id", "akamaiDefined", "createdBy", "createdDate", "aggressiveMode", "patternDetails", "patterns" ], "type": "object", "x-akamai": { "file-path": "schemas/dlp-dictionary.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Create a DLP dictionary", "tags": [ "DLP dictionaries" ] }, "get": { "description": "Lists all DLP dictionaries for the configuration.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-dictionaries" }, "operationId": "get-dictionaries", "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": [ { "aggressiveMode": false, "akamaiDefined": true, "createdBy": "tyamada", "createdDate": "2021-03-31T13:00:01.041+00:00", "id": 1242, "modifiedBy": "szhang", "modifiedDate": "2021-09-14T09:00:01.138+00:00", "name": "PCI DSS Universal", "patternDetails": [ { "description": "Specified quantity of both credit or debit card numbers and of associated phrases such as:-\n* \"csv\"\n* \"Expiry Date\"\n* \"Bankleitzahl\"\n* \"American Express\"\n* \"handelsbanken\"\n\nFor a definition of credit card numbers that are detected please see the CCL description for \"Credit card numbers [Universal]\".", "id": 13, "name": "Credit card numbers - with phrases [Universal]" }, { "description": "Credit, debit, travel, store or membership card numbers using a common bank identification numbering system. Such as:-\n* 16 digit card numbers (including MasterCard and VISA)\n* American Express\n* CUP (China Union Pay)\n* Diners Club\n* Ita\u00fa Unibanco\n* JCB\n* Maestro\n* Royal Bank of Canada\n* ScotiBank\n* Verve\n* magnetic track data containing card numbers\n\nCard numbers must conform to the following:-\n* Start with a \"3\", \"4\", \"5\" or \"6\" i.e. be a standard format ISO/IEC 7812 number with a Major Industry Identifier (MII) for 'Travel and entertainment', 'Banking and financial' or 'Merchandising and banking/financial'.\n* If not 16 digits then start with a recognised Issuer Identification Number (IIN)\n* Have an appropriate length for the card issuer\n* Either be contiguous or have an appropriate digit grouping for the issuer\n* Any digit groupings to be separated by a white space \" \", dash \"-\" or dash variant\n* Have a valid Luhn check digit\n* Must not appear to be part of a larger digit sequence\n\nNOTE: Card numbers used for other non-financial purposes but that use the same format as monetary cards will be detected as credit cards. This is because:- \n* These cards typically have high PII risk\n* Loyalty cards (etc.) often do have an actual financial value or financial consequence\n* Card issuers have been known to upgrade loyalty & travel cards to have a financial value", "id": 14, "name": "Credit card numbers [Universal]" }, { "description": "Card magnetic track 2 data according to the ISO/IEC 7813 specification.\n\nThis detection is included within the CCL \"Credit card numbers [Global]\". \nThis CCL is provided as an optional level of granularity.", "id": 128, "name": "Credit card magnetic track 2 [Universal]" }, { "description": "Card magnetic track 1 data according to the ISO/IEC 7813 specification.\n\nThis detection is included in the CCL \"Credit card numbers [Global]\". \nThis CCL is provided as an optional level of granularity.", "id": 127, "name": "Credit card magnetic track 1 [Universal]" } ], "patterns": [ 13, 14, 128, 127 ], "policies": [] }, { "aggressiveMode": false, "akamaiDefined": true, "createdBy": "hgildong", "createdDate": "2021-03-31T13:00:01.041+00:00", "id": 1147, "modifiedBy": "tyamada", "modifiedDate": "2021-09-14T09:00:01.138+00:00", "name": "PII Universal", "patternDetails": [ { "description": "Passport number and qualifying phrases.\r\nCountries supported: Australia, Brazil, Canada, France, Germany, Ireland, Italy, Spain, UK, USA", "id": 97, "name": "Passport details [Global]" }, { "description": "Specified quantity of both credit or debit card numbers and of associated phrases such as:-\n* \"csv\"\n* \"Expiry Date\"\n* \"Bankleitzahl\"\n* \"American Express\"\n* \"handelsbanken\"\n\nFor a definition of credit card numbers that are detected please see the CCL description for \"Credit card numbers [Universal]\".", "id": 13, "name": "Credit card numbers - with phrases [Universal]" }, { "description": "Credit, debit, travel, store or membership card numbers using a common bank identification numbering system. Such as:-\n* 16 digit card numbers (including MasterCard and VISA)\n* American Express\n* CUP (China Union Pay)\n* Diners Club\n* Ita\u00fa Unibanco\n* JCB\n* Maestro\n* Royal Bank of Canada\n* ScotiBank\n* Verve\n* magnetic track data containing card numbers\n\nCard numbers must conform to the following:-\n* Start with a \"3\", \"4\", \"5\" or \"6\" i.e. be a standard format ISO/IEC 7812 number with a Major Industry Identifier (MII) for 'Travel and entertainment', 'Banking and financial' or 'Merchandising and banking/financial'.\n* If not 16 digits then start with a recognised Issuer Identification Number (IIN)\n* Have an appropriate length for the card issuer\n* Either be contiguous or have an appropriate digit grouping for the issuer\n* Any digit groupings to be separated by a white space \" \", dash \"-\" or dash variant\n* Have a valid Luhn check digit\n* Must not appear to be part of a larger digit sequence\n\nNOTE: Card numbers used for other non-financial purposes but that use the same format as monetary cards will be detected as credit cards. This is because:- \n* These cards typically have high PII risk\n* Loyalty cards (etc.) often do have an actual financial value or financial consequence\n* Card issuers have been known to upgrade loyalty & travel cards to have a financial value", "id": 14, "name": "Credit card numbers [Universal]" } ], "patterns": [ 97, 13, 14 ], "policies": [] } ], "schema": { "description": "All data loss protection (DLP) dictionaries for a configuration.", "items": { "additionalProperties": false, "description": "Lists parameters in the DLP dictionary object.", "properties": { "aggressiveMode": { "description": "Enables aggressive mode.", "type": "boolean" }, "akamaiDefined": { "description": "Indicates an Akamai-defined dictionary.", "type": "boolean" }, "createdBy": { "description": "__Read-only__ Name of the user who created this dictionary.", "minLength": 1, "readOnly": true, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the dictionary's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "Description of the dictionary.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ The unique identifier for the data loss protection (DLP) dictionary.", "minimum": 1, "readOnly": true, "type": "integer" }, "modifiedBy": { "description": "__Read-only__ Name of the user who most recently modified the dictionary.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking when this dictionary's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the dictionary.", "minLength": 1, "type": "string" }, "patternDetails": { "description": "The pattern details.", "items": { "additionalProperties": false, "description": "Lists DLP pattern detail properties.", "properties": { "description": { "description": "A description of the DLP pattern.", "minLength": 1, "type": "string" }, "id": { "description": "A unique identifier for the data loss protection (DLP) pattern.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the DLP pattern.", "minLength": 1, "type": "string" } }, "required": [ "name", "description", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/dlp-pattern-details.yaml" } }, "minItems": 0, "type": "array" }, "patterns": { "description": "The pattern ID.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "policies": { "description": "Lists the security policy assigned to a site. Configure the accepted use policy and set responses for known and suspected threats under specified categories.", "items": { "additionalProperties": false, "description": "The security policy to assign to a site. Configure the accepted use policy and set responses for known and suspected threats under the specified categories.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Marks a policy as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated administrators for the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks a policy as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "akamaiDefined": { "description": "Marks a policy as Akamai-defined.", "type": "boolean" }, "aupSettings": { "description": "Contains the acceptable use policy settings.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AUP category data.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "groups": { "description": "Groups users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Describes the operation settings on the AUP setting.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Lists user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "categoryId" ], "type": "object" }, "minItems": 0, "type": "array" }, "aupSource": { "description": "Name of acceptable use policy source for the policy.", "minLength": 1, "type": "string" }, "authPolicy": { "additionalProperties": false, "description": "Details of the authorization policy adopted for the policy.", "properties": { "Oidc": { "additionalProperties": false, "description": "Provides OpenID Connect (OIDC) provider and client details.", "properties": { "client": { "additionalProperties": false, "description": "Provides information about a client.", "properties": { "authUri": { "description": "URL for authorization.", "type": "string" }, "checkSessionUri": { "description": "URL to check if session is alive.", "type": "string" }, "clientId": { "description": "__Read-only__ A unique identifier for the client.", "minimum": 1, "readOnly": true, "type": "integer" }, "clientName": { "description": "Name of the client.", "minLength": 1, "type": "string" }, "endSessionUri": { "description": "URL for ending session.", "type": "string" }, "frontChannelLogoutUrl": { "description": "URLs for logout from front channel.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "grantTypes": { "description": "Client grant types.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "idpId": { "description": "__Read-only__ A unique identifier for the IDP for the OIDC.", "minLength": 1, "readOnly": true, "type": "string" }, "javascriptOrigins": { "description": "JavaScript origin locations.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "postLogoutUris": { "description": "URIs for post logout from client.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "redirectUris": { "description": "URLs for redirection.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "tokenUri": { "description": "URL for token.", "type": "string" }, "userUri": { "description": "URL for user information.", "type": "string" } }, "required": [ "authUri", "checkSessionUri", "clientId", "clientName", "endSessionUri", "frontChannelLogoutUrl", "grantTypes", "idpId", "javascriptOrigins", "postLogoutUris", "redirectUris", "tokenUri", "userUri" ], "type": "object" }, "provider": { "additionalProperties": false, "description": "Mapping of authorization policy URLs to OpenID Connect (OIDC) URLs.", "properties": { "authPolicyUrl": { "description": "The URL from the authorization policy.", "type": "string" }, "oidcUrl": { "description": "The URL for the OpenID Connect (OIDC).", "type": "string" } }, "required": [ "authPolicyUrl", "oidcUrl" ], "type": "object" } }, "required": [ "client", "provider" ], "type": "object" }, "allowUnauthenticated": { "description": "Allows unauthenticated users.", "type": "boolean" }, "enabled": { "description": "Enables an authorization policy.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the authorization policy.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpPreAuthConsent": { "description": "Indicates IDP pre-authorization consent.", "type": "boolean" }, "retryAuthForUnauthenticatedSessions": { "description": "The number of retries for an unauthenticated session.", "minimum": 0, "type": "integer" }, "sessionTtl": { "description": "The duration of a session.", "minimum": 0, "type": "integer" }, "userInfoRefreshTime": { "description": "__Read-only__ ISO 8601 timestamp marking the last user authentication refresh.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "Oidc", "enabled", "id", "idpPreAuthConsent", "allowUnauthenticated", "retryAuthForUnauthenticatedSessions", "sessionTtl", "userInfoRefreshTime" ], "type": "object" }, "authenticationMode": { "description": "Specifies the authentication mode. Either `REQUIRED`, `OPTIONAL`, or `NONE`.", "enum": [ "REQUIRED", "OPTIONAL", "NONE" ], "type": "string" }, "avcSettings": { "additionalProperties": false, "description": "Contains the AVC setting properties.", "properties": { "applicationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "categorySettings": { "description": "Lists the AVC category setting properties.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "Contains data for a category.", "properties": { "code": { "description": "The acceptable use policy categorization code.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The selected default action for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the category.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the category.", "minLength": 1, "type": "string" } }, "required": [ "name", "code", "defaultActionId", "deprecated", "id" ], "type": "object" }, "description": { "description": "Description for the category settings.", "minLength": 1, "type": "string" }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "Contains response data.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "description", "categoryId", "categoryInfo", "groups", "operationSettings", "response", "responseId", "responseOverrides", "users" ], "type": "object" }, "minItems": 0, "type": "array" }, "riskSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "applicationSettings", "categorySettings", "riskSettings" ], "type": "object" }, "basicSettings": { "additionalProperties": false, "description": "Contains the basic policy settings.", "properties": { "dnssec": { "description": "When enabled, provides DNS security.", "type": "boolean" }, "edns0ecs": { "description": "When enabled, optimizes CDN traffic using the `EDNS-Client-Subnet` extension.", "type": "boolean" }, "forwardProxyEnabled": { "description": "Enables the forward proxy.", "type": "boolean" }, "proxyEnabled": { "description": "Enables the proxy.", "type": "boolean" }, "safesearch": { "description": "Enables the safe search feature.", "type": "boolean" }, "trustXFF": { "description": "Enables trust of `X-Forwarded-For` headers.", "type": "boolean" } }, "required": [ "dnssec", "edns0ecs" ], "type": "object" }, "classifiers": { "additionalProperties": false, "description": "Contains classifier details for a policy.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis for a classifier.", "type": "boolean" }, "enabled": { "description": "Enables the classifier.", "type": "boolean" }, "name": { "description": "Name of the classifier.", "minLength": 1, "type": "string" }, "sizeExceedingAction": { "description": "The size exceeded action.", "minimum": 0, "type": "integer" }, "zdpEnabled": { "description": "Enables Zero-Day Phishing (ZDP) protection for a classifier.", "type": "boolean" } }, "required": [ "name", "dynamicAnalysisEnabled", "enabled", "sizeExceedingAction", "zdpEnabled" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this policy.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "customHeaders": { "description": "Lists the policy custom header settings.", "items": { "additionalProperties": false, "description": "Lists the policy custom header object properties.", "properties": { "customHeaderId": { "description": "__Read-only__ The custom header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "domains": { "description": "Lists the domains assigned the custom header.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "headerName": { "description": "Name of the custom header.", "minLength": 1, "type": "string" }, "headerValue": { "description": "Custom header value.", "minLength": 1, "type": "string" } }, "required": [ "customHeaderId", "domains", "headerName", "headerValue" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-custom-header.yaml" } }, "minItems": 0, "type": "array" }, "customRequestHeaders": { "additionalProperties": false, "description": "Lists the policy custom request header settings.", "properties": { "args": { "description": "Lists custom request header arguments.", "items": { "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ The custom request header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "target_domain": { "description": "The target domain for the custom request headers.", "minLength": 1, "type": "string" } }, "required": [ "args", "id", "target_domain" ], "type": "object" }, "description": { "description": "A description of the policy that you provide.", "minLength": 1, "type": "string" }, "dlpExceptions": { "additionalProperties": false, "description": "Lists the DLP exceptions for the policy.", "properties": { "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "groups", "users" ], "type": "object" }, "dlpSettings": { "description": "Data loss prevention (DLP) actions and details.", "items": { "additionalProperties": false, "properties": { "action": { "description": "Action ID for the data loss prevention (DLP) dictionary.", "minimum": 0, "type": "integer" }, "dictionaryId": { "description": "__Read-only__ A unique identifier for the DLP dictionary.", "minimum": 1, "readOnly": true, "type": "integer" }, "dictionaryName": { "description": "Name of the DLP dictionary.", "minLength": 1, "type": "string" }, "dictionarySource": { "description": "Name of the DLP dictionary source.", "minLength": 1, "type": "string" }, "patterns": { "description": "Data loss prevention (DLP) patterns to match.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "threshold": { "description": "The maximum number of DLP patterns to consider.", "minimum": 0, "type": "integer" } }, "required": [ "action", "dictionaryId", "dictionaryName", "dictionarySource", "patterns", "threshold" ], "type": "object" }, "minItems": 0, "type": "array" }, "fWaasSettings": { "description": "Lists firewall as a service settings.", "items": { "additionalProperties": false, "description": "Configures Firewall as service.", "properties": { "appIds": { "description": "Lists app IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "countryCodeInfo": { "description": "Lists country code info.", "items": { "additionalProperties": false, "description": "Specifies firewall as a service geolocation data.", "properties": { "alpha2Code": { "description": "The ISO 3166 two-letter code for the region.", "minLength": 1, "type": "string" }, "alpha3Code": { "description": "The ISO 3166 three-letter code for the region.", "minLength": 1, "type": "string" }, "countryName": { "description": "Name of the firewall service.", "minLength": 1, "type": "string" } }, "required": [ "countryName", "alpha2Code", "alpha3Code" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-geo-info.yaml" } }, "minItems": 0, "type": "array" }, "countryCodes": { "description": "Lists country codes.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "destinationIp": { "description": "Lists destination IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "enabled": { "description": "Enables the service.", "type": "boolean" }, "fWaaSId": { "description": "Unique identifier for the firewall as service.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the service.", "minLength": 1, "type": "string" }, "networkServiceIds": { "description": "Lists network service IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "networkServiceInfo": { "description": "Lists network service info details.", "items": { "additionalProperties": false, "description": "Contains firewall as a service information.", "properties": { "description": { "description": "Name of the firewall as a service.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ Unique identifier for the firewall service.", "minimum": 1, "readOnly": true, "type": "integer" }, "port": { "description": "The port used by the firewall service.", "minLength": 1, "type": "string" }, "protocol": { "description": "Indicates the protocol used by firewall service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "serviceName": { "description": "Name of the Firewall as a Service.", "minLength": 1, "type": "string" } }, "required": [ "description", "id", "serviceName", "port", "protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-info.yaml" } }, "minItems": 0, "type": "array" }, "nonWebAppInfo": { "description": "Lists non-web-app info.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "ports": { "description": "Lists ports.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "protocol": { "description": "Describes the protocol used by service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "rank": { "description": "Priority of the service.", "minimum": 0, "type": "integer" }, "responseId": { "description": "__Read-only__ ID of the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "sourceIp": { "description": "Lists source IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "type": { "description": "Specifies the service type, either `IP`, `APP`, `NETWORK_SERVICE`, `GEO`, or `DEFAULT`.", "enum": [ "IP", "APP", "NETWORK_SERVICE", "GEO", "DEFAULT" ], "type": "string" } }, "required": [ "name", "type", "fWaaSId", "rank", "enabled", "responseId", "sourceIp", "destinationIp", "ports", "protocol", "appIds", "countryCodes", "networkServiceIds", "networkServiceInfo", "countryCodeInfo", "nonWebAppInfo" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-settings.yaml" } }, "minItems": 0, "type": "array" }, "farmId": { "description": "__Read-only__ A unique identifier for policy's farm.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeSettings": { "description": "Lists the filetype settings for the policy.", "items": { "additionalProperties": false, "description": "Lists the file type setting parameters.", "properties": { "applyTo": { "description": "Lists policies to apply the file type settings to.", "minLength": 1, "type": "string" }, "fileTypeId": { "description": "__Read-only__ Identifies each file type.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeInfo": { "additionalProperties": false, "description": "Contains file type info properties.", "properties": { "category": { "description": "The file category.", "minLength": 1, "type": "string" }, "code": { "description": "The file's code.", "minLength": 1, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The file's default action ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the file.", "type": "boolean" }, "id": { "description": "__Read-only__ Lists the file ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The filename.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "category", "defaultActionId", "deprecated", "code" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-info.yaml" } }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "name": { "description": "Name of the file type.", "minLength": 1, "type": "string" }, "responseId": { "description": "__Read-only__ Lists the response ID for the file type setting.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Provides details about response.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseOverrides": { "description": "Contains the AVC response override details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "type": { "description": "Lists the file type.", "minLength": 1, "type": "string" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "type", "responseId", "fileTypeId", "users", "groups", "responseInfo", "responseOverrides", "fileTypeInfo", "applyTo" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-settings.yaml" } }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ A unique identifier for each policy. Use this value for a `policyId` parameter in subsequent operations.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpId": { "description": "__Read-only__ A unique identifier for the associated identity provider.", "minLength": 1, "readOnly": true, "type": "string" }, "ipaSettings": { "additionalProperties": false, "description": "Contains IPA settings.", "properties": { "blockOnUploadScanTimeout": { "description": "Blocks on upload scan timeout.", "type": "boolean" }, "blockUnscannableFiles": { "description": "Blocks unscannable files.", "type": "boolean" }, "enabled": { "description": "Enables IPA.", "type": "boolean" }, "randomCheck": { "description": "Enables random check for `ipaSettings`.", "type": "boolean" }, "zdp": { "description": "Enables Zero-Day Phishing (ZDP) protection.", "type": "boolean" } }, "required": [ "enabled", "randomCheck", "zdp" ], "type": "object" }, "modifiedBy": { "description": "Name of the user who most recently modified this policy.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the policy.", "minLength": 1, "type": "string" }, "originPorts": { "description": "Lists origin ports for a policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "originValidationFailActionId": { "description": "__Read-only__ A unique identifier for a validation fail action.", "minimum": 1, "readOnly": true, "type": "integer" }, "policyGeneralSettings": { "additionalProperties": false, "description": "Specifies the policy's general settings.", "properties": { "androidDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "aupMigrated": { "description": "Migrates acceptable use policy.", "type": "boolean" }, "avcEnabled": { "description": "Enables the AVC.", "type": "boolean" }, "blockBrokenTLS": { "description": "Blocks broken TLS traffic.", "type": "boolean" }, "bypassO365": { "description": "Bypasses Microsoft Office 365 traffic.", "type": "boolean" }, "chromeOSDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "classifyMigrated": { "description": "Migrates classify information.", "type": "boolean" }, "disableClient": { "description": "Disables the SIA client.", "type": "boolean" }, "disableInsecureCiphers": { "description": "Disables insecure ciphers.", "type": "boolean" }, "dotConfig": { "additionalProperties": false, "description": "Contains DNS over TLS configuration.", "properties": { "mode": { "description": "The DNS over TLS mode:\n- `ATTEMPT` always tries to use DOT and falls back to standard DNS when unavailable.\n- `REQUIRED` requires DOT and informs the client the device isn't protected.\n- `DISABLED` doesn't apply DOT to secure DNS traffic.", "enum": [ "ATTEMPT", "REQUIRED", "DISABLED" ], "type": "string" }, "port": { "description": "The assigned port for `dotConfig`.", "minimum": 0, "type": "integer" } }, "required": [ "mode", "port" ], "type": "object" }, "enableIPIntelligence": { "description": "Enables IP intelligence.", "type": "boolean" }, "etpClientMultiUserEnabled": { "description": "Enables multi-user on the SIA client.", "type": "boolean" }, "fwaasEnabled": { "description": "Enables Firewall as a Service.", "type": "boolean" }, "httpProxyOverride": { "description": "Represents HTTP proxy override priority.", "minimum": 0, "type": "integer" }, "iOSDefaultAction": { "description": "Specifies the default action on iOS devices.", "minimum": 0, "type": "integer" }, "idpUserInfoRetryInterval": { "description": "Specifies the retry interval value for IDP users.", "minimum": 0, "type": "integer" }, "ignoreLocalDNSResolvers": { "description": "Ignores local DNS resolution.", "type": "boolean" }, "localBreakoutForBypass": { "description": "Enables local breakout for bypass.", "type": "boolean" }, "proxyAuthEnabled": { "description": "Enables proxy authentication.", "type": "boolean" }, "wgExceptions": { "description": "Enables walled-garden exceptions.", "type": "boolean" } }, "type": "object" }, "proxyHostname": { "description": "Name of proxy host machine.", "type": "string" }, "riskyFileHandlingSettings": { "additionalProperties": false, "description": "Describes file handling settings.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis.", "type": "boolean" }, "hugeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for huge risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "largeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for large risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "hugeRiskyFileResponse", "largeRiskyFileResponse" ], "type": "object" }, "safeSearchSettings": { "additionalProperties": false, "description": "Contains safe search settings.", "properties": { "youtube": { "description": "Specifies the Youtube access policy, either `open`, `moderate`, or `strict`.", "enum": [ "open", "moderate", "strict" ], "type": "string" } }, "required": [ "youtube" ], "type": "object" }, "securitySettings": { "description": "Contains the policy security settings.", "items": { "additionalProperties": false, "description": "Contains the policy security settings.", "properties": { "confirmedGroups": { "description": "Confirmed groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "confirmedResponseId": { "description": "A unique identifier for the confirmed response.", "minimum": 1, "type": "integer" }, "confirmedResponseInfo": { "additionalProperties": false, "description": "Contains data about the confirmed response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the confirmed response info.", "minimum": 0, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the confirmed response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "confirmedUsers": { "description": "Confirmed users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "listId": { "description": "A unique identifier for the list.", "minimum": 1, "type": "integer" }, "listInfo": { "additionalProperties": false, "description": "List information.", "properties": { "categoryId": { "description": "The unique category ID.", "minimum": 1, "type": "integer" }, "id": { "description": "A unique identifier for the list info.", "minimum": 0, "type": "integer" }, "listType": { "description": "The list type. See [List types](https://techdocs.akamai.com/etp-config/reference/list-types) for details.", "enum": [ "AKAMAI", "TOP_LEVEL_DOMAIN", "WHITELIST", "FILEHASHLIST", "FILEHASH_BLOCK", "DOMAIN_IP_LIST", "URL_BLOCK", "URL_BYPASS" ], "type": "string" }, "name": { "description": "The name of the list info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "categoryId" ], "type": "object" }, "responseOverridesConfirmed": { "description": "Response overrides for confirmed response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "responseOverridesSuspected": { "description": "Response overrides for suspected response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "shouldNotifyConfirmed": { "description": "Send alert on confirmed list hit.", "type": "boolean" }, "shouldNotifySuspected": { "description": "Send alert on suspected list hit.", "type": "boolean" }, "suspectedGroups": { "description": "Suspected groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "suspectedResponseId": { "description": "A unique identifier for the suspected response.", "minimum": 1, "type": "integer" }, "suspectedResponseInfo": { "additionalProperties": false, "description": "Suspected response data.", "properties": { "id": { "description": "A unique identifier for the suspected response info.", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the suspected response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "suspectedUsers": { "description": "Suspected users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "listId", "confirmedResponseId", "shouldNotifyConfirmed", "shouldNotifySuspected" ], "type": "object", "x-akamai": { "file-path": "schemas/security-settings-info.yaml" } }, "minItems": 0, "type": "array" }, "sites": { "description": "Contains associated site IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "sitesInfo": { "description": "Contains data about associated sites.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the site.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the site.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "sublocationInfo": { "description": "Lists sublocation info.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id-name.yaml" } }, "minItems": 0, "type": "array" }, "sublocations": { "description": "Lists the sublocations configured for this policy.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "trafficLogging": { "additionalProperties": false, "description": "Provides details of traffic logging in different modes.", "properties": { "headers": { "additionalProperties": false, "description": "Contains header information for traffic.", "properties": { "request": { "additionalProperties": false, "description": "The request details in the header.", "properties": { "mode": { "description": "Request mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" }, "response": { "additionalProperties": false, "description": "The response details in the header.", "properties": { "mode": { "description": "Response mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" } }, "required": [ "request", "response" ], "type": "object" }, "mode": { "description": "The traffic logging mode. Either `full`, `url`, `path`, or `host`.", "enum": [ "full", "url", "path", "host" ], "type": "string" }, "url": { "additionalProperties": false, "description": "URL details of the traffic.", "properties": { "mode": { "description": "The URL mode used for traffic logging. Either `FULL`, `PATH`, or `HOST`.", "enum": [ "FULL", "PATH", "HOST" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } }, "required": [ "headers", "mode", "url" ], "type": "object" } }, "required": [ "description", "name", "aupSettings", "securitySettings" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-retrieve-specific.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "name", "id", "akamaiDefined", "createdBy", "createdDate", "aggressiveMode", "patternDetails", "patterns" ], "type": "object", "x-akamai": { "file-path": "schemas/dlp-dictionary.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/dlp-dictionaries.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List DLP dictionaries", "tags": [ "DLP dictionaries" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/dictionaries.yaml", "path-info": "/configs/{configId}/dictionaries" } }, "/configs/{configId}/dictionaries/{dictionaryId}": { "get": { "description": "Returns details of a DLP dictionary.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-dictionary" }, "operationId": "get-dictionary", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "aggressiveMode": false, "akamaiDefined": true, "createdBy": "jsmith", "createdDate": "2021-03-31T13:00:01.041+00:00", "id": 1242, "modifiedBy": "jperez", "modifiedDate": "2021-09-14T09:00:01.138+00:00", "name": "PCI DSS Universal", "patternDetails": [ { "description": "Specified quantity of both credit or debit card numbers and of associated phrases such as:-\n* \"csv\"\n* \"Expiry Date\"\n* \"Bankleitzahl\"\n* \"American Express\"\n* \"handelsbanken\"\n\nFor a definition of credit card numbers that are detected please see the CCL description for \"Credit card numbers [Universal]\".", "id": 13, "name": "Credit card numbers - with phrases [Universal]" }, { "description": "Credit, debit, travel, store or membership card numbers using a common bank identification numbering system. Such as:-\n* 16 digit card numbers (including MasterCard and VISA)\n* American Express\n* CUP (China Union Pay)\n* Diners Club\n* Ita\u00fa Unibanco\n* JCB\n* Maestro\n* Royal Bank of Canada\n* ScotiBank\n* Verve\n* magnetic track data containing card numbers\n\nCard numbers must conform to the following:-\n* Start with a \"3\", \"4\", \"5\" or \"6\" i.e. be a standard format ISO/IEC 7812 number with a Major Industry Identifier (MII) for 'Travel and entertainment', 'Banking and financial' or 'Merchandising and banking/financial'.\n* If not 16 digits then start with a recognised Issuer Identification Number (IIN)\n* Have an appropriate length for the card issuer\n* Either be contiguous or have an appropriate digit grouping for the issuer\n* Any digit groupings to be separated by a white space \" \", dash \"-\" or dash variant\n* Have a valid Luhn check digit\n* Must not appear to be part of a larger digit sequence\n\nNOTE: Card numbers used for other non-financial purposes but that use the same format as monetary cards will be detected as credit cards. This is because:- \n* These cards typically have high PII risk\n* Loyalty cards (etc.) often do have an actual financial value or financial consequence\n* Card issuers have been known to upgrade loyalty & travel cards to have a financial value", "id": 14, "name": "Credit card numbers [Universal]" }, { "description": "Card magnetic track 2 data according to the ISO/IEC 7813 specification.\n\nThis detection is included within the CCL \"Credit card numbers [Global]\". \nThis CCL is provided as an optional level of granularity.", "id": 128, "name": "Credit card magnetic track 2 [Universal]" }, { "description": "Card magnetic track 1 data according to the ISO/IEC 7813 specification.\n\nThis detection is included in the CCL \"Credit card numbers [Global]\". \nThis CCL is provided as an optional level of granularity.", "id": 127, "name": "Credit card magnetic track 1 [Universal]" } ], "patterns": [ 13, 14, 128, 127 ], "policies": [] }, "schema": { "additionalProperties": false, "description": "Lists parameters in the DLP dictionary object.", "properties": { "aggressiveMode": { "description": "Enables aggressive mode.", "type": "boolean" }, "akamaiDefined": { "description": "Indicates an Akamai-defined dictionary.", "type": "boolean" }, "createdBy": { "description": "__Read-only__ Name of the user who created this dictionary.", "minLength": 1, "readOnly": true, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the dictionary's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "Description of the dictionary.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ The unique identifier for the data loss protection (DLP) dictionary.", "minimum": 1, "readOnly": true, "type": "integer" }, "modifiedBy": { "description": "__Read-only__ Name of the user who most recently modified the dictionary.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking when this dictionary's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the dictionary.", "minLength": 1, "type": "string" }, "patternDetails": { "description": "The pattern details.", "items": { "additionalProperties": false, "description": "Lists DLP pattern detail properties.", "properties": { "description": { "description": "A description of the DLP pattern.", "minLength": 1, "type": "string" }, "id": { "description": "A unique identifier for the data loss protection (DLP) pattern.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the DLP pattern.", "minLength": 1, "type": "string" } }, "required": [ "name", "description", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/dlp-pattern-details.yaml" } }, "minItems": 0, "type": "array" }, "patterns": { "description": "The pattern ID.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "policies": { "description": "Lists the security policy assigned to a site. Configure the accepted use policy and set responses for known and suspected threats under specified categories.", "items": { "additionalProperties": false, "description": "The security policy to assign to a site. Configure the accepted use policy and set responses for known and suspected threats under the specified categories.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Marks a policy as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated administrators for the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks a policy as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "akamaiDefined": { "description": "Marks a policy as Akamai-defined.", "type": "boolean" }, "aupSettings": { "description": "Contains the acceptable use policy settings.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AUP category data.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "groups": { "description": "Groups users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Describes the operation settings on the AUP setting.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Lists user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "categoryId" ], "type": "object" }, "minItems": 0, "type": "array" }, "aupSource": { "description": "Name of acceptable use policy source for the policy.", "minLength": 1, "type": "string" }, "authPolicy": { "additionalProperties": false, "description": "Details of the authorization policy adopted for the policy.", "properties": { "Oidc": { "additionalProperties": false, "description": "Provides OpenID Connect (OIDC) provider and client details.", "properties": { "client": { "additionalProperties": false, "description": "Provides information about a client.", "properties": { "authUri": { "description": "URL for authorization.", "type": "string" }, "checkSessionUri": { "description": "URL to check if session is alive.", "type": "string" }, "clientId": { "description": "__Read-only__ A unique identifier for the client.", "minimum": 1, "readOnly": true, "type": "integer" }, "clientName": { "description": "Name of the client.", "minLength": 1, "type": "string" }, "endSessionUri": { "description": "URL for ending session.", "type": "string" }, "frontChannelLogoutUrl": { "description": "URLs for logout from front channel.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "grantTypes": { "description": "Client grant types.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "idpId": { "description": "__Read-only__ A unique identifier for the IDP for the OIDC.", "minLength": 1, "readOnly": true, "type": "string" }, "javascriptOrigins": { "description": "JavaScript origin locations.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "postLogoutUris": { "description": "URIs for post logout from client.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "redirectUris": { "description": "URLs for redirection.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "tokenUri": { "description": "URL for token.", "type": "string" }, "userUri": { "description": "URL for user information.", "type": "string" } }, "required": [ "authUri", "checkSessionUri", "clientId", "clientName", "endSessionUri", "frontChannelLogoutUrl", "grantTypes", "idpId", "javascriptOrigins", "postLogoutUris", "redirectUris", "tokenUri", "userUri" ], "type": "object" }, "provider": { "additionalProperties": false, "description": "Mapping of authorization policy URLs to OpenID Connect (OIDC) URLs.", "properties": { "authPolicyUrl": { "description": "The URL from the authorization policy.", "type": "string" }, "oidcUrl": { "description": "The URL for the OpenID Connect (OIDC).", "type": "string" } }, "required": [ "authPolicyUrl", "oidcUrl" ], "type": "object" } }, "required": [ "client", "provider" ], "type": "object" }, "allowUnauthenticated": { "description": "Allows unauthenticated users.", "type": "boolean" }, "enabled": { "description": "Enables an authorization policy.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the authorization policy.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpPreAuthConsent": { "description": "Indicates IDP pre-authorization consent.", "type": "boolean" }, "retryAuthForUnauthenticatedSessions": { "description": "The number of retries for an unauthenticated session.", "minimum": 0, "type": "integer" }, "sessionTtl": { "description": "The duration of a session.", "minimum": 0, "type": "integer" }, "userInfoRefreshTime": { "description": "__Read-only__ ISO 8601 timestamp marking the last user authentication refresh.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "Oidc", "enabled", "id", "idpPreAuthConsent", "allowUnauthenticated", "retryAuthForUnauthenticatedSessions", "sessionTtl", "userInfoRefreshTime" ], "type": "object" }, "authenticationMode": { "description": "Specifies the authentication mode. Either `REQUIRED`, `OPTIONAL`, or `NONE`.", "enum": [ "REQUIRED", "OPTIONAL", "NONE" ], "type": "string" }, "avcSettings": { "additionalProperties": false, "description": "Contains the AVC setting properties.", "properties": { "applicationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "categorySettings": { "description": "Lists the AVC category setting properties.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "Contains data for a category.", "properties": { "code": { "description": "The acceptable use policy categorization code.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The selected default action for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the category.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the category.", "minLength": 1, "type": "string" } }, "required": [ "name", "code", "defaultActionId", "deprecated", "id" ], "type": "object" }, "description": { "description": "Description for the category settings.", "minLength": 1, "type": "string" }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "Contains response data.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "description", "categoryId", "categoryInfo", "groups", "operationSettings", "response", "responseId", "responseOverrides", "users" ], "type": "object" }, "minItems": 0, "type": "array" }, "riskSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "applicationSettings", "categorySettings", "riskSettings" ], "type": "object" }, "basicSettings": { "additionalProperties": false, "description": "Contains the basic policy settings.", "properties": { "dnssec": { "description": "When enabled, provides DNS security.", "type": "boolean" }, "edns0ecs": { "description": "When enabled, optimizes CDN traffic using the `EDNS-Client-Subnet` extension.", "type": "boolean" }, "forwardProxyEnabled": { "description": "Enables the forward proxy.", "type": "boolean" }, "proxyEnabled": { "description": "Enables the proxy.", "type": "boolean" }, "safesearch": { "description": "Enables the safe search feature.", "type": "boolean" }, "trustXFF": { "description": "Enables trust of `X-Forwarded-For` headers.", "type": "boolean" } }, "required": [ "dnssec", "edns0ecs" ], "type": "object" }, "classifiers": { "additionalProperties": false, "description": "Contains classifier details for a policy.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis for a classifier.", "type": "boolean" }, "enabled": { "description": "Enables the classifier.", "type": "boolean" }, "name": { "description": "Name of the classifier.", "minLength": 1, "type": "string" }, "sizeExceedingAction": { "description": "The size exceeded action.", "minimum": 0, "type": "integer" }, "zdpEnabled": { "description": "Enables Zero-Day Phishing (ZDP) protection for a classifier.", "type": "boolean" } }, "required": [ "name", "dynamicAnalysisEnabled", "enabled", "sizeExceedingAction", "zdpEnabled" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this policy.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "customHeaders": { "description": "Lists the policy custom header settings.", "items": { "additionalProperties": false, "description": "Lists the policy custom header object properties.", "properties": { "customHeaderId": { "description": "__Read-only__ The custom header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "domains": { "description": "Lists the domains assigned the custom header.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "headerName": { "description": "Name of the custom header.", "minLength": 1, "type": "string" }, "headerValue": { "description": "Custom header value.", "minLength": 1, "type": "string" } }, "required": [ "customHeaderId", "domains", "headerName", "headerValue" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-custom-header.yaml" } }, "minItems": 0, "type": "array" }, "customRequestHeaders": { "additionalProperties": false, "description": "Lists the policy custom request header settings.", "properties": { "args": { "description": "Lists custom request header arguments.", "items": { "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ The custom request header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "target_domain": { "description": "The target domain for the custom request headers.", "minLength": 1, "type": "string" } }, "required": [ "args", "id", "target_domain" ], "type": "object" }, "description": { "description": "A description of the policy that you provide.", "minLength": 1, "type": "string" }, "dlpExceptions": { "additionalProperties": false, "description": "Lists the DLP exceptions for the policy.", "properties": { "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "groups", "users" ], "type": "object" }, "dlpSettings": { "description": "Data loss prevention (DLP) actions and details.", "items": { "additionalProperties": false, "properties": { "action": { "description": "Action ID for the data loss prevention (DLP) dictionary.", "minimum": 0, "type": "integer" }, "dictionaryId": { "description": "__Read-only__ A unique identifier for the DLP dictionary.", "minimum": 1, "readOnly": true, "type": "integer" }, "dictionaryName": { "description": "Name of the DLP dictionary.", "minLength": 1, "type": "string" }, "dictionarySource": { "description": "Name of the DLP dictionary source.", "minLength": 1, "type": "string" }, "patterns": { "description": "Data loss prevention (DLP) patterns to match.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "threshold": { "description": "The maximum number of DLP patterns to consider.", "minimum": 0, "type": "integer" } }, "required": [ "action", "dictionaryId", "dictionaryName", "dictionarySource", "patterns", "threshold" ], "type": "object" }, "minItems": 0, "type": "array" }, "fWaasSettings": { "description": "Lists firewall as a service settings.", "items": { "additionalProperties": false, "description": "Configures Firewall as service.", "properties": { "appIds": { "description": "Lists app IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "countryCodeInfo": { "description": "Lists country code info.", "items": { "additionalProperties": false, "description": "Specifies firewall as a service geolocation data.", "properties": { "alpha2Code": { "description": "The ISO 3166 two-letter code for the region.", "minLength": 1, "type": "string" }, "alpha3Code": { "description": "The ISO 3166 three-letter code for the region.", "minLength": 1, "type": "string" }, "countryName": { "description": "Name of the firewall service.", "minLength": 1, "type": "string" } }, "required": [ "countryName", "alpha2Code", "alpha3Code" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-geo-info.yaml" } }, "minItems": 0, "type": "array" }, "countryCodes": { "description": "Lists country codes.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "destinationIp": { "description": "Lists destination IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "enabled": { "description": "Enables the service.", "type": "boolean" }, "fWaaSId": { "description": "Unique identifier for the firewall as service.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the service.", "minLength": 1, "type": "string" }, "networkServiceIds": { "description": "Lists network service IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "networkServiceInfo": { "description": "Lists network service info details.", "items": { "additionalProperties": false, "description": "Contains firewall as a service information.", "properties": { "description": { "description": "Name of the firewall as a service.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ Unique identifier for the firewall service.", "minimum": 1, "readOnly": true, "type": "integer" }, "port": { "description": "The port used by the firewall service.", "minLength": 1, "type": "string" }, "protocol": { "description": "Indicates the protocol used by firewall service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "serviceName": { "description": "Name of the Firewall as a Service.", "minLength": 1, "type": "string" } }, "required": [ "description", "id", "serviceName", "port", "protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-info.yaml" } }, "minItems": 0, "type": "array" }, "nonWebAppInfo": { "description": "Lists non-web-app info.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "ports": { "description": "Lists ports.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "protocol": { "description": "Describes the protocol used by service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "rank": { "description": "Priority of the service.", "minimum": 0, "type": "integer" }, "responseId": { "description": "__Read-only__ ID of the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "sourceIp": { "description": "Lists source IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "type": { "description": "Specifies the service type, either `IP`, `APP`, `NETWORK_SERVICE`, `GEO`, or `DEFAULT`.", "enum": [ "IP", "APP", "NETWORK_SERVICE", "GEO", "DEFAULT" ], "type": "string" } }, "required": [ "name", "type", "fWaaSId", "rank", "enabled", "responseId", "sourceIp", "destinationIp", "ports", "protocol", "appIds", "countryCodes", "networkServiceIds", "networkServiceInfo", "countryCodeInfo", "nonWebAppInfo" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-settings.yaml" } }, "minItems": 0, "type": "array" }, "farmId": { "description": "__Read-only__ A unique identifier for policy's farm.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeSettings": { "description": "Lists the filetype settings for the policy.", "items": { "additionalProperties": false, "description": "Lists the file type setting parameters.", "properties": { "applyTo": { "description": "Lists policies to apply the file type settings to.", "minLength": 1, "type": "string" }, "fileTypeId": { "description": "__Read-only__ Identifies each file type.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeInfo": { "additionalProperties": false, "description": "Contains file type info properties.", "properties": { "category": { "description": "The file category.", "minLength": 1, "type": "string" }, "code": { "description": "The file's code.", "minLength": 1, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The file's default action ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the file.", "type": "boolean" }, "id": { "description": "__Read-only__ Lists the file ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The filename.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "category", "defaultActionId", "deprecated", "code" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-info.yaml" } }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "name": { "description": "Name of the file type.", "minLength": 1, "type": "string" }, "responseId": { "description": "__Read-only__ Lists the response ID for the file type setting.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Provides details about response.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseOverrides": { "description": "Contains the AVC response override details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "type": { "description": "Lists the file type.", "minLength": 1, "type": "string" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "type", "responseId", "fileTypeId", "users", "groups", "responseInfo", "responseOverrides", "fileTypeInfo", "applyTo" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-settings.yaml" } }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ A unique identifier for each policy. Use this value for a `policyId` parameter in subsequent operations.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpId": { "description": "__Read-only__ A unique identifier for the associated identity provider.", "minLength": 1, "readOnly": true, "type": "string" }, "ipaSettings": { "additionalProperties": false, "description": "Contains IPA settings.", "properties": { "blockOnUploadScanTimeout": { "description": "Blocks on upload scan timeout.", "type": "boolean" }, "blockUnscannableFiles": { "description": "Blocks unscannable files.", "type": "boolean" }, "enabled": { "description": "Enables IPA.", "type": "boolean" }, "randomCheck": { "description": "Enables random check for `ipaSettings`.", "type": "boolean" }, "zdp": { "description": "Enables Zero-Day Phishing (ZDP) protection.", "type": "boolean" } }, "required": [ "enabled", "randomCheck", "zdp" ], "type": "object" }, "modifiedBy": { "description": "Name of the user who most recently modified this policy.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the policy.", "minLength": 1, "type": "string" }, "originPorts": { "description": "Lists origin ports for a policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "originValidationFailActionId": { "description": "__Read-only__ A unique identifier for a validation fail action.", "minimum": 1, "readOnly": true, "type": "integer" }, "policyGeneralSettings": { "additionalProperties": false, "description": "Specifies the policy's general settings.", "properties": { "androidDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "aupMigrated": { "description": "Migrates acceptable use policy.", "type": "boolean" }, "avcEnabled": { "description": "Enables the AVC.", "type": "boolean" }, "blockBrokenTLS": { "description": "Blocks broken TLS traffic.", "type": "boolean" }, "bypassO365": { "description": "Bypasses Microsoft Office 365 traffic.", "type": "boolean" }, "chromeOSDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "classifyMigrated": { "description": "Migrates classify information.", "type": "boolean" }, "disableClient": { "description": "Disables the SIA client.", "type": "boolean" }, "disableInsecureCiphers": { "description": "Disables insecure ciphers.", "type": "boolean" }, "dotConfig": { "additionalProperties": false, "description": "Contains DNS over TLS configuration.", "properties": { "mode": { "description": "The DNS over TLS mode:\n- `ATTEMPT` always tries to use DOT and falls back to standard DNS when unavailable.\n- `REQUIRED` requires DOT and informs the client the device isn't protected.\n- `DISABLED` doesn't apply DOT to secure DNS traffic.", "enum": [ "ATTEMPT", "REQUIRED", "DISABLED" ], "type": "string" }, "port": { "description": "The assigned port for `dotConfig`.", "minimum": 0, "type": "integer" } }, "required": [ "mode", "port" ], "type": "object" }, "enableIPIntelligence": { "description": "Enables IP intelligence.", "type": "boolean" }, "etpClientMultiUserEnabled": { "description": "Enables multi-user on the SIA client.", "type": "boolean" }, "fwaasEnabled": { "description": "Enables Firewall as a Service.", "type": "boolean" }, "httpProxyOverride": { "description": "Represents HTTP proxy override priority.", "minimum": 0, "type": "integer" }, "iOSDefaultAction": { "description": "Specifies the default action on iOS devices.", "minimum": 0, "type": "integer" }, "idpUserInfoRetryInterval": { "description": "Specifies the retry interval value for IDP users.", "minimum": 0, "type": "integer" }, "ignoreLocalDNSResolvers": { "description": "Ignores local DNS resolution.", "type": "boolean" }, "localBreakoutForBypass": { "description": "Enables local breakout for bypass.", "type": "boolean" }, "proxyAuthEnabled": { "description": "Enables proxy authentication.", "type": "boolean" }, "wgExceptions": { "description": "Enables walled-garden exceptions.", "type": "boolean" } }, "type": "object" }, "proxyHostname": { "description": "Name of proxy host machine.", "type": "string" }, "riskyFileHandlingSettings": { "additionalProperties": false, "description": "Describes file handling settings.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis.", "type": "boolean" }, "hugeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for huge risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "largeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for large risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "hugeRiskyFileResponse", "largeRiskyFileResponse" ], "type": "object" }, "safeSearchSettings": { "additionalProperties": false, "description": "Contains safe search settings.", "properties": { "youtube": { "description": "Specifies the Youtube access policy, either `open`, `moderate`, or `strict`.", "enum": [ "open", "moderate", "strict" ], "type": "string" } }, "required": [ "youtube" ], "type": "object" }, "securitySettings": { "description": "Contains the policy security settings.", "items": { "additionalProperties": false, "description": "Contains the policy security settings.", "properties": { "confirmedGroups": { "description": "Confirmed groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "confirmedResponseId": { "description": "A unique identifier for the confirmed response.", "minimum": 1, "type": "integer" }, "confirmedResponseInfo": { "additionalProperties": false, "description": "Contains data about the confirmed response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the confirmed response info.", "minimum": 0, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the confirmed response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "confirmedUsers": { "description": "Confirmed users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "listId": { "description": "A unique identifier for the list.", "minimum": 1, "type": "integer" }, "listInfo": { "additionalProperties": false, "description": "List information.", "properties": { "categoryId": { "description": "The unique category ID.", "minimum": 1, "type": "integer" }, "id": { "description": "A unique identifier for the list info.", "minimum": 0, "type": "integer" }, "listType": { "description": "The list type. See [List types](https://techdocs.akamai.com/etp-config/reference/list-types) for details.", "enum": [ "AKAMAI", "TOP_LEVEL_DOMAIN", "WHITELIST", "FILEHASHLIST", "FILEHASH_BLOCK", "DOMAIN_IP_LIST", "URL_BLOCK", "URL_BYPASS" ], "type": "string" }, "name": { "description": "The name of the list info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "categoryId" ], "type": "object" }, "responseOverridesConfirmed": { "description": "Response overrides for confirmed response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "responseOverridesSuspected": { "description": "Response overrides for suspected response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "shouldNotifyConfirmed": { "description": "Send alert on confirmed list hit.", "type": "boolean" }, "shouldNotifySuspected": { "description": "Send alert on suspected list hit.", "type": "boolean" }, "suspectedGroups": { "description": "Suspected groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "suspectedResponseId": { "description": "A unique identifier for the suspected response.", "minimum": 1, "type": "integer" }, "suspectedResponseInfo": { "additionalProperties": false, "description": "Suspected response data.", "properties": { "id": { "description": "A unique identifier for the suspected response info.", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the suspected response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "suspectedUsers": { "description": "Suspected users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "listId", "confirmedResponseId", "shouldNotifyConfirmed", "shouldNotifySuspected" ], "type": "object", "x-akamai": { "file-path": "schemas/security-settings-info.yaml" } }, "minItems": 0, "type": "array" }, "sites": { "description": "Contains associated site IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "sitesInfo": { "description": "Contains data about associated sites.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the site.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the site.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "sublocationInfo": { "description": "Lists sublocation info.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id-name.yaml" } }, "minItems": 0, "type": "array" }, "sublocations": { "description": "Lists the sublocations configured for this policy.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "trafficLogging": { "additionalProperties": false, "description": "Provides details of traffic logging in different modes.", "properties": { "headers": { "additionalProperties": false, "description": "Contains header information for traffic.", "properties": { "request": { "additionalProperties": false, "description": "The request details in the header.", "properties": { "mode": { "description": "Request mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" }, "response": { "additionalProperties": false, "description": "The response details in the header.", "properties": { "mode": { "description": "Response mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" } }, "required": [ "request", "response" ], "type": "object" }, "mode": { "description": "The traffic logging mode. Either `full`, `url`, `path`, or `host`.", "enum": [ "full", "url", "path", "host" ], "type": "string" }, "url": { "additionalProperties": false, "description": "URL details of the traffic.", "properties": { "mode": { "description": "The URL mode used for traffic logging. Either `FULL`, `PATH`, or `HOST`.", "enum": [ "FULL", "PATH", "HOST" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } }, "required": [ "headers", "mode", "url" ], "type": "object" } }, "required": [ "description", "name", "aupSettings", "securitySettings" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-retrieve-specific.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "name", "id", "akamaiDefined", "createdBy", "createdDate", "aggressiveMode", "patternDetails", "patterns" ], "type": "object", "x-akamai": { "file-path": "schemas/dlp-dictionary.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Get a DLP dictionary", "tags": [ "DLP dictionaries" ] }, "put": { "description": "Updates a DLP dictionary.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-dictionary" }, "operationId": "put-dictionary", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "aggressiveMode": false, "akamaiDefined": true, "createdBy": "jsmith", "createdDate": "2021-03-31T13:00:01.041+00:00", "id": 1242, "modifiedBy": "jperez", "modifiedDate": "2021-09-14T09:00:01.138+00:00", "name": "PCI DSS Universal", "patternDetails": [ { "description": "Specified quantity of both credit or debit card numbers and of associated phrases such as:-\n* \"csv\"\n* \"Expiry Date\"\n* \"Bankleitzahl\"\n* \"American Express\"\n* \"handelsbanken\"\n\nFor a definition of credit card numbers that are detected please see the CCL description for \"Credit card numbers [Universal]\".", "id": 13, "name": "Credit card numbers - with phrases [Universal]" }, { "description": "Credit, debit, travel, store or membership card numbers using a common bank identification numbering system. Such as:-\n* 16 digit card numbers (including MasterCard and VISA)\n* American Express\n* CUP (China Union Pay)\n* Diners Club\n* Ita\u00fa Unibanco\n* JCB\n* Maestro\n* Royal Bank of Canada\n* ScotiBank\n* Verve\n* magnetic track data containing card numbers\n\nCard numbers must conform to the following:-\n* Start with a \"3\", \"4\", \"5\" or \"6\" i.e. be a standard format ISO/IEC 7812 number with a Major Industry Identifier (MII) for 'Travel and entertainment', 'Banking and financial' or 'Merchandising and banking/financial'.\n* If not 16 digits then start with a recognised Issuer Identification Number (IIN)\n* Have an appropriate length for the card issuer\n* Either be contiguous or have an appropriate digit grouping for the issuer\n* Any digit groupings to be separated by a white space \" \", dash \"-\" or dash variant\n* Have a valid Luhn check digit\n* Must not appear to be part of a larger digit sequence\n\nNOTE: Card numbers used for other non-financial purposes but that use the same format as monetary cards will be detected as credit cards. This is because:- \n* These cards typically have high PII risk\n* Loyalty cards (etc.) often do have an actual financial value or financial consequence\n* Card issuers have been known to upgrade loyalty & travel cards to have a financial value", "id": 14, "name": "Credit card numbers [Universal]" }, { "description": "Card magnetic track 2 data according to the ISO/IEC 7813 specification.\n\nThis detection is included within the CCL \"Credit card numbers [Global]\". \nThis CCL is provided as an optional level of granularity.", "id": 128, "name": "Credit card magnetic track 2 [Universal]" }, { "description": "Card magnetic track 1 data according to the ISO/IEC 7813 specification.\n\nThis detection is included in the CCL \"Credit card numbers [Global]\". \nThis CCL is provided as an optional level of granularity.", "id": 127, "name": "Credit card magnetic track 1 [Universal]" } ], "patterns": [ 13, 14, 128, 127 ], "policies": [] }, "schema": { "additionalProperties": false, "description": "Lists parameters in the DLP dictionary object.", "properties": { "aggressiveMode": { "description": "Enables aggressive mode.", "type": "boolean" }, "akamaiDefined": { "description": "Indicates an Akamai-defined dictionary.", "type": "boolean" }, "createdBy": { "description": "__Read-only__ Name of the user who created this dictionary.", "minLength": 1, "readOnly": true, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the dictionary's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "Description of the dictionary.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ The unique identifier for the data loss protection (DLP) dictionary.", "minimum": 1, "readOnly": true, "type": "integer" }, "modifiedBy": { "description": "__Read-only__ Name of the user who most recently modified the dictionary.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking when this dictionary's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the dictionary.", "minLength": 1, "type": "string" }, "patternDetails": { "description": "The pattern details.", "items": { "additionalProperties": false, "description": "Lists DLP pattern detail properties.", "properties": { "description": { "description": "A description of the DLP pattern.", "minLength": 1, "type": "string" }, "id": { "description": "A unique identifier for the data loss protection (DLP) pattern.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the DLP pattern.", "minLength": 1, "type": "string" } }, "required": [ "name", "description", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/dlp-pattern-details.yaml" } }, "minItems": 0, "type": "array" }, "patterns": { "description": "The pattern ID.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "policies": { "description": "Lists the security policy assigned to a site. Configure the accepted use policy and set responses for known and suspected threats under specified categories.", "items": { "additionalProperties": false, "description": "The security policy to assign to a site. Configure the accepted use policy and set responses for known and suspected threats under the specified categories.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Marks a policy as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated administrators for the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks a policy as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "akamaiDefined": { "description": "Marks a policy as Akamai-defined.", "type": "boolean" }, "aupSettings": { "description": "Contains the acceptable use policy settings.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AUP category data.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "groups": { "description": "Groups users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Describes the operation settings on the AUP setting.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Lists user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "categoryId" ], "type": "object" }, "minItems": 0, "type": "array" }, "aupSource": { "description": "Name of acceptable use policy source for the policy.", "minLength": 1, "type": "string" }, "authPolicy": { "additionalProperties": false, "description": "Details of the authorization policy adopted for the policy.", "properties": { "Oidc": { "additionalProperties": false, "description": "Provides OpenID Connect (OIDC) provider and client details.", "properties": { "client": { "additionalProperties": false, "description": "Provides information about a client.", "properties": { "authUri": { "description": "URL for authorization.", "type": "string" }, "checkSessionUri": { "description": "URL to check if session is alive.", "type": "string" }, "clientId": { "description": "__Read-only__ A unique identifier for the client.", "minimum": 1, "readOnly": true, "type": "integer" }, "clientName": { "description": "Name of the client.", "minLength": 1, "type": "string" }, "endSessionUri": { "description": "URL for ending session.", "type": "string" }, "frontChannelLogoutUrl": { "description": "URLs for logout from front channel.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "grantTypes": { "description": "Client grant types.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "idpId": { "description": "__Read-only__ A unique identifier for the IDP for the OIDC.", "minLength": 1, "readOnly": true, "type": "string" }, "javascriptOrigins": { "description": "JavaScript origin locations.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "postLogoutUris": { "description": "URIs for post logout from client.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "redirectUris": { "description": "URLs for redirection.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "tokenUri": { "description": "URL for token.", "type": "string" }, "userUri": { "description": "URL for user information.", "type": "string" } }, "required": [ "authUri", "checkSessionUri", "clientId", "clientName", "endSessionUri", "frontChannelLogoutUrl", "grantTypes", "idpId", "javascriptOrigins", "postLogoutUris", "redirectUris", "tokenUri", "userUri" ], "type": "object" }, "provider": { "additionalProperties": false, "description": "Mapping of authorization policy URLs to OpenID Connect (OIDC) URLs.", "properties": { "authPolicyUrl": { "description": "The URL from the authorization policy.", "type": "string" }, "oidcUrl": { "description": "The URL for the OpenID Connect (OIDC).", "type": "string" } }, "required": [ "authPolicyUrl", "oidcUrl" ], "type": "object" } }, "required": [ "client", "provider" ], "type": "object" }, "allowUnauthenticated": { "description": "Allows unauthenticated users.", "type": "boolean" }, "enabled": { "description": "Enables an authorization policy.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the authorization policy.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpPreAuthConsent": { "description": "Indicates IDP pre-authorization consent.", "type": "boolean" }, "retryAuthForUnauthenticatedSessions": { "description": "The number of retries for an unauthenticated session.", "minimum": 0, "type": "integer" }, "sessionTtl": { "description": "The duration of a session.", "minimum": 0, "type": "integer" }, "userInfoRefreshTime": { "description": "__Read-only__ ISO 8601 timestamp marking the last user authentication refresh.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "Oidc", "enabled", "id", "idpPreAuthConsent", "allowUnauthenticated", "retryAuthForUnauthenticatedSessions", "sessionTtl", "userInfoRefreshTime" ], "type": "object" }, "authenticationMode": { "description": "Specifies the authentication mode. Either `REQUIRED`, `OPTIONAL`, or `NONE`.", "enum": [ "REQUIRED", "OPTIONAL", "NONE" ], "type": "string" }, "avcSettings": { "additionalProperties": false, "description": "Contains the AVC setting properties.", "properties": { "applicationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "categorySettings": { "description": "Lists the AVC category setting properties.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "Contains data for a category.", "properties": { "code": { "description": "The acceptable use policy categorization code.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The selected default action for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the category.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the category.", "minLength": 1, "type": "string" } }, "required": [ "name", "code", "defaultActionId", "deprecated", "id" ], "type": "object" }, "description": { "description": "Description for the category settings.", "minLength": 1, "type": "string" }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "Contains response data.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "description", "categoryId", "categoryInfo", "groups", "operationSettings", "response", "responseId", "responseOverrides", "users" ], "type": "object" }, "minItems": 0, "type": "array" }, "riskSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "applicationSettings", "categorySettings", "riskSettings" ], "type": "object" }, "basicSettings": { "additionalProperties": false, "description": "Contains the basic policy settings.", "properties": { "dnssec": { "description": "When enabled, provides DNS security.", "type": "boolean" }, "edns0ecs": { "description": "When enabled, optimizes CDN traffic using the `EDNS-Client-Subnet` extension.", "type": "boolean" }, "forwardProxyEnabled": { "description": "Enables the forward proxy.", "type": "boolean" }, "proxyEnabled": { "description": "Enables the proxy.", "type": "boolean" }, "safesearch": { "description": "Enables the safe search feature.", "type": "boolean" }, "trustXFF": { "description": "Enables trust of `X-Forwarded-For` headers.", "type": "boolean" } }, "required": [ "dnssec", "edns0ecs" ], "type": "object" }, "classifiers": { "additionalProperties": false, "description": "Contains classifier details for a policy.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis for a classifier.", "type": "boolean" }, "enabled": { "description": "Enables the classifier.", "type": "boolean" }, "name": { "description": "Name of the classifier.", "minLength": 1, "type": "string" }, "sizeExceedingAction": { "description": "The size exceeded action.", "minimum": 0, "type": "integer" }, "zdpEnabled": { "description": "Enables Zero-Day Phishing (ZDP) protection for a classifier.", "type": "boolean" } }, "required": [ "name", "dynamicAnalysisEnabled", "enabled", "sizeExceedingAction", "zdpEnabled" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this policy.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "customHeaders": { "description": "Lists the policy custom header settings.", "items": { "additionalProperties": false, "description": "Lists the policy custom header object properties.", "properties": { "customHeaderId": { "description": "__Read-only__ The custom header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "domains": { "description": "Lists the domains assigned the custom header.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "headerName": { "description": "Name of the custom header.", "minLength": 1, "type": "string" }, "headerValue": { "description": "Custom header value.", "minLength": 1, "type": "string" } }, "required": [ "customHeaderId", "domains", "headerName", "headerValue" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-custom-header.yaml" } }, "minItems": 0, "type": "array" }, "customRequestHeaders": { "additionalProperties": false, "description": "Lists the policy custom request header settings.", "properties": { "args": { "description": "Lists custom request header arguments.", "items": { "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ The custom request header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "target_domain": { "description": "The target domain for the custom request headers.", "minLength": 1, "type": "string" } }, "required": [ "args", "id", "target_domain" ], "type": "object" }, "description": { "description": "A description of the policy that you provide.", "minLength": 1, "type": "string" }, "dlpExceptions": { "additionalProperties": false, "description": "Lists the DLP exceptions for the policy.", "properties": { "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "groups", "users" ], "type": "object" }, "dlpSettings": { "description": "Data loss prevention (DLP) actions and details.", "items": { "additionalProperties": false, "properties": { "action": { "description": "Action ID for the data loss prevention (DLP) dictionary.", "minimum": 0, "type": "integer" }, "dictionaryId": { "description": "__Read-only__ A unique identifier for the DLP dictionary.", "minimum": 1, "readOnly": true, "type": "integer" }, "dictionaryName": { "description": "Name of the DLP dictionary.", "minLength": 1, "type": "string" }, "dictionarySource": { "description": "Name of the DLP dictionary source.", "minLength": 1, "type": "string" }, "patterns": { "description": "Data loss prevention (DLP) patterns to match.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "threshold": { "description": "The maximum number of DLP patterns to consider.", "minimum": 0, "type": "integer" } }, "required": [ "action", "dictionaryId", "dictionaryName", "dictionarySource", "patterns", "threshold" ], "type": "object" }, "minItems": 0, "type": "array" }, "fWaasSettings": { "description": "Lists firewall as a service settings.", "items": { "additionalProperties": false, "description": "Configures Firewall as service.", "properties": { "appIds": { "description": "Lists app IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "countryCodeInfo": { "description": "Lists country code info.", "items": { "additionalProperties": false, "description": "Specifies firewall as a service geolocation data.", "properties": { "alpha2Code": { "description": "The ISO 3166 two-letter code for the region.", "minLength": 1, "type": "string" }, "alpha3Code": { "description": "The ISO 3166 three-letter code for the region.", "minLength": 1, "type": "string" }, "countryName": { "description": "Name of the firewall service.", "minLength": 1, "type": "string" } }, "required": [ "countryName", "alpha2Code", "alpha3Code" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-geo-info.yaml" } }, "minItems": 0, "type": "array" }, "countryCodes": { "description": "Lists country codes.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "destinationIp": { "description": "Lists destination IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "enabled": { "description": "Enables the service.", "type": "boolean" }, "fWaaSId": { "description": "Unique identifier for the firewall as service.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the service.", "minLength": 1, "type": "string" }, "networkServiceIds": { "description": "Lists network service IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "networkServiceInfo": { "description": "Lists network service info details.", "items": { "additionalProperties": false, "description": "Contains firewall as a service information.", "properties": { "description": { "description": "Name of the firewall as a service.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ Unique identifier for the firewall service.", "minimum": 1, "readOnly": true, "type": "integer" }, "port": { "description": "The port used by the firewall service.", "minLength": 1, "type": "string" }, "protocol": { "description": "Indicates the protocol used by firewall service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "serviceName": { "description": "Name of the Firewall as a Service.", "minLength": 1, "type": "string" } }, "required": [ "description", "id", "serviceName", "port", "protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-info.yaml" } }, "minItems": 0, "type": "array" }, "nonWebAppInfo": { "description": "Lists non-web-app info.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "ports": { "description": "Lists ports.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "protocol": { "description": "Describes the protocol used by service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "rank": { "description": "Priority of the service.", "minimum": 0, "type": "integer" }, "responseId": { "description": "__Read-only__ ID of the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "sourceIp": { "description": "Lists source IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "type": { "description": "Specifies the service type, either `IP`, `APP`, `NETWORK_SERVICE`, `GEO`, or `DEFAULT`.", "enum": [ "IP", "APP", "NETWORK_SERVICE", "GEO", "DEFAULT" ], "type": "string" } }, "required": [ "name", "type", "fWaaSId", "rank", "enabled", "responseId", "sourceIp", "destinationIp", "ports", "protocol", "appIds", "countryCodes", "networkServiceIds", "networkServiceInfo", "countryCodeInfo", "nonWebAppInfo" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-settings.yaml" } }, "minItems": 0, "type": "array" }, "farmId": { "description": "__Read-only__ A unique identifier for policy's farm.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeSettings": { "description": "Lists the filetype settings for the policy.", "items": { "additionalProperties": false, "description": "Lists the file type setting parameters.", "properties": { "applyTo": { "description": "Lists policies to apply the file type settings to.", "minLength": 1, "type": "string" }, "fileTypeId": { "description": "__Read-only__ Identifies each file type.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeInfo": { "additionalProperties": false, "description": "Contains file type info properties.", "properties": { "category": { "description": "The file category.", "minLength": 1, "type": "string" }, "code": { "description": "The file's code.", "minLength": 1, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The file's default action ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the file.", "type": "boolean" }, "id": { "description": "__Read-only__ Lists the file ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The filename.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "category", "defaultActionId", "deprecated", "code" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-info.yaml" } }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "name": { "description": "Name of the file type.", "minLength": 1, "type": "string" }, "responseId": { "description": "__Read-only__ Lists the response ID for the file type setting.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Provides details about response.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseOverrides": { "description": "Contains the AVC response override details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "type": { "description": "Lists the file type.", "minLength": 1, "type": "string" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "type", "responseId", "fileTypeId", "users", "groups", "responseInfo", "responseOverrides", "fileTypeInfo", "applyTo" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-settings.yaml" } }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ A unique identifier for each policy. Use this value for a `policyId` parameter in subsequent operations.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpId": { "description": "__Read-only__ A unique identifier for the associated identity provider.", "minLength": 1, "readOnly": true, "type": "string" }, "ipaSettings": { "additionalProperties": false, "description": "Contains IPA settings.", "properties": { "blockOnUploadScanTimeout": { "description": "Blocks on upload scan timeout.", "type": "boolean" }, "blockUnscannableFiles": { "description": "Blocks unscannable files.", "type": "boolean" }, "enabled": { "description": "Enables IPA.", "type": "boolean" }, "randomCheck": { "description": "Enables random check for `ipaSettings`.", "type": "boolean" }, "zdp": { "description": "Enables Zero-Day Phishing (ZDP) protection.", "type": "boolean" } }, "required": [ "enabled", "randomCheck", "zdp" ], "type": "object" }, "modifiedBy": { "description": "Name of the user who most recently modified this policy.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the policy.", "minLength": 1, "type": "string" }, "originPorts": { "description": "Lists origin ports for a policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "originValidationFailActionId": { "description": "__Read-only__ A unique identifier for a validation fail action.", "minimum": 1, "readOnly": true, "type": "integer" }, "policyGeneralSettings": { "additionalProperties": false, "description": "Specifies the policy's general settings.", "properties": { "androidDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "aupMigrated": { "description": "Migrates acceptable use policy.", "type": "boolean" }, "avcEnabled": { "description": "Enables the AVC.", "type": "boolean" }, "blockBrokenTLS": { "description": "Blocks broken TLS traffic.", "type": "boolean" }, "bypassO365": { "description": "Bypasses Microsoft Office 365 traffic.", "type": "boolean" }, "chromeOSDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "classifyMigrated": { "description": "Migrates classify information.", "type": "boolean" }, "disableClient": { "description": "Disables the SIA client.", "type": "boolean" }, "disableInsecureCiphers": { "description": "Disables insecure ciphers.", "type": "boolean" }, "dotConfig": { "additionalProperties": false, "description": "Contains DNS over TLS configuration.", "properties": { "mode": { "description": "The DNS over TLS mode:\n- `ATTEMPT` always tries to use DOT and falls back to standard DNS when unavailable.\n- `REQUIRED` requires DOT and informs the client the device isn't protected.\n- `DISABLED` doesn't apply DOT to secure DNS traffic.", "enum": [ "ATTEMPT", "REQUIRED", "DISABLED" ], "type": "string" }, "port": { "description": "The assigned port for `dotConfig`.", "minimum": 0, "type": "integer" } }, "required": [ "mode", "port" ], "type": "object" }, "enableIPIntelligence": { "description": "Enables IP intelligence.", "type": "boolean" }, "etpClientMultiUserEnabled": { "description": "Enables multi-user on the SIA client.", "type": "boolean" }, "fwaasEnabled": { "description": "Enables Firewall as a Service.", "type": "boolean" }, "httpProxyOverride": { "description": "Represents HTTP proxy override priority.", "minimum": 0, "type": "integer" }, "iOSDefaultAction": { "description": "Specifies the default action on iOS devices.", "minimum": 0, "type": "integer" }, "idpUserInfoRetryInterval": { "description": "Specifies the retry interval value for IDP users.", "minimum": 0, "type": "integer" }, "ignoreLocalDNSResolvers": { "description": "Ignores local DNS resolution.", "type": "boolean" }, "localBreakoutForBypass": { "description": "Enables local breakout for bypass.", "type": "boolean" }, "proxyAuthEnabled": { "description": "Enables proxy authentication.", "type": "boolean" }, "wgExceptions": { "description": "Enables walled-garden exceptions.", "type": "boolean" } }, "type": "object" }, "proxyHostname": { "description": "Name of proxy host machine.", "type": "string" }, "riskyFileHandlingSettings": { "additionalProperties": false, "description": "Describes file handling settings.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis.", "type": "boolean" }, "hugeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for huge risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "largeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for large risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "hugeRiskyFileResponse", "largeRiskyFileResponse" ], "type": "object" }, "safeSearchSettings": { "additionalProperties": false, "description": "Contains safe search settings.", "properties": { "youtube": { "description": "Specifies the Youtube access policy, either `open`, `moderate`, or `strict`.", "enum": [ "open", "moderate", "strict" ], "type": "string" } }, "required": [ "youtube" ], "type": "object" }, "securitySettings": { "description": "Contains the policy security settings.", "items": { "additionalProperties": false, "description": "Contains the policy security settings.", "properties": { "confirmedGroups": { "description": "Confirmed groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "confirmedResponseId": { "description": "A unique identifier for the confirmed response.", "minimum": 1, "type": "integer" }, "confirmedResponseInfo": { "additionalProperties": false, "description": "Contains data about the confirmed response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the confirmed response info.", "minimum": 0, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the confirmed response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "confirmedUsers": { "description": "Confirmed users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "listId": { "description": "A unique identifier for the list.", "minimum": 1, "type": "integer" }, "listInfo": { "additionalProperties": false, "description": "List information.", "properties": { "categoryId": { "description": "The unique category ID.", "minimum": 1, "type": "integer" }, "id": { "description": "A unique identifier for the list info.", "minimum": 0, "type": "integer" }, "listType": { "description": "The list type. See [List types](https://techdocs.akamai.com/etp-config/reference/list-types) for details.", "enum": [ "AKAMAI", "TOP_LEVEL_DOMAIN", "WHITELIST", "FILEHASHLIST", "FILEHASH_BLOCK", "DOMAIN_IP_LIST", "URL_BLOCK", "URL_BYPASS" ], "type": "string" }, "name": { "description": "The name of the list info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "categoryId" ], "type": "object" }, "responseOverridesConfirmed": { "description": "Response overrides for confirmed response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "responseOverridesSuspected": { "description": "Response overrides for suspected response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "shouldNotifyConfirmed": { "description": "Send alert on confirmed list hit.", "type": "boolean" }, "shouldNotifySuspected": { "description": "Send alert on suspected list hit.", "type": "boolean" }, "suspectedGroups": { "description": "Suspected groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "suspectedResponseId": { "description": "A unique identifier for the suspected response.", "minimum": 1, "type": "integer" }, "suspectedResponseInfo": { "additionalProperties": false, "description": "Suspected response data.", "properties": { "id": { "description": "A unique identifier for the suspected response info.", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the suspected response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "suspectedUsers": { "description": "Suspected users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "listId", "confirmedResponseId", "shouldNotifyConfirmed", "shouldNotifySuspected" ], "type": "object", "x-akamai": { "file-path": "schemas/security-settings-info.yaml" } }, "minItems": 0, "type": "array" }, "sites": { "description": "Contains associated site IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "sitesInfo": { "description": "Contains data about associated sites.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the site.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the site.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "sublocationInfo": { "description": "Lists sublocation info.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id-name.yaml" } }, "minItems": 0, "type": "array" }, "sublocations": { "description": "Lists the sublocations configured for this policy.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "trafficLogging": { "additionalProperties": false, "description": "Provides details of traffic logging in different modes.", "properties": { "headers": { "additionalProperties": false, "description": "Contains header information for traffic.", "properties": { "request": { "additionalProperties": false, "description": "The request details in the header.", "properties": { "mode": { "description": "Request mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" }, "response": { "additionalProperties": false, "description": "The response details in the header.", "properties": { "mode": { "description": "Response mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" } }, "required": [ "request", "response" ], "type": "object" }, "mode": { "description": "The traffic logging mode. Either `full`, `url`, `path`, or `host`.", "enum": [ "full", "url", "path", "host" ], "type": "string" }, "url": { "additionalProperties": false, "description": "URL details of the traffic.", "properties": { "mode": { "description": "The URL mode used for traffic logging. Either `FULL`, `PATH`, or `HOST`.", "enum": [ "FULL", "PATH", "HOST" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } }, "required": [ "headers", "mode", "url" ], "type": "object" } }, "required": [ "description", "name", "aupSettings", "securitySettings" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-retrieve-specific.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "name", "id", "akamaiDefined", "createdBy", "createdDate", "aggressiveMode", "patternDetails", "patterns" ], "type": "object", "x-akamai": { "file-path": "schemas/dlp-dictionary.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Update a DLP dictionary", "tags": [ "DLP dictionaries" ] }, "delete": { "description": "Deletes a specific DLP dictionary.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/delete-dictionary" }, "operationId": "delete-dictionary", "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": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Remove a DLP dictionary", "tags": [ "DLP dictionaries" ] }, "parameters": [ { "description": "A unique identifier for each dlp-dictionary.", "in": "path", "name": "dictionaryId", "required": true, "schema": { "example": 123, "type": "integer" }, "x-akamai": { "file-path": "parameters/dictionary-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/dictionary.yaml", "path-info": "/configs/{configId}/dictionaries/{dictionaryId}" } }, "/configs/{configId}/dns-vips": { "get": { "description": "Provides DNS virtual IP details.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-dns-vips" }, "operationId": "get-dns-vips", "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": { "ipv4Addrs": { "primary": "192.0.2.51", "secondary": "192.0.2.205" }, "ipv6Addrs": { "primary": "2001:db8:5b85:2f95:944:5097:21e2:a5d0", "secondary": "2001:db8:ac37:2acf:67e6:7d3f:fc40:33e6" } }, "schema": { "additionalProperties": false, "description": "Lists details about the DNS Virtual IP.", "properties": { "ipv4Addrs": { "additionalProperties": false, "description": "Lists the IPv4 address properties.", "properties": { "primary": { "description": "The primary IP address in IPv4 format.", "minLength": 1, "type": "string" }, "secondary": { "description": "The secondary IP address in IPv4 format.", "minLength": 1, "type": "string" } }, "required": [ "primary", "secondary" ], "type": "object" }, "ipv6Addrs": { "additionalProperties": false, "description": "Lists the IPv6 address properties.", "properties": { "primary": { "description": "The primary IP address in IPv6 format.", "minLength": 1, "type": "string" }, "secondary": { "description": "The secondary IP address in IPv6 format.", "minLength": 1, "type": "string" } }, "required": [ "primary", "secondary" ], "type": "object" }, "status": { "description": "Indicates the DNS VIP's status.", "minimum": 0, "type": "integer" } }, "required": [ "ipv4Addrs", "ipv6Addrs" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-vips.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List DNS VIPs", "tags": [ "DNS VIPs" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/dns-vips.yaml", "path-info": "/configs/{configId}/dns-vips" } }, "/configs/{configId}/firstTimeWizard": { "get": { "description": "Provides the first time wizard status.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-firsttimewizard" }, "operationId": "get-firsttimewizard", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "playIntroVideo": false, "step": 1, "videoLink": "https://link to video location" }, "schema": { "additionalProperties": false, "description": "Lists the wizard state properties.", "properties": { "playIntroVideo": { "description": "Marks the introduction video as played.", "type": "boolean" }, "step": { "description": "Indicates the last step completed in the wizard.", "minimum": 0, "type": "integer" }, "videoLink": { "description": "The link to the introduction video.", "minLength": 1, "type": "string" } }, "required": [ "playIntroVideo", "step" ], "type": "object", "x-akamai": { "file-path": "schemas/first-time-wizard-get-state.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get the first time wizard state", "tags": [ "Configuration wizard" ] }, "put": { "description": "Updates the status of the first time wizard.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-firsttimewizard" }, "operationId": "put-firsttimewizard", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "step": 2 }, "schema": { "additionalProperties": false, "description": "Lists the wizard state update properties.", "properties": { "step": { "description": "Updates the last step completed in the wizard.", "minimum": 0, "type": "integer" } }, "required": [ "step" ], "type": "object", "x-akamai": { "file-path": "schemas/first-time-wizard-update-state.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "playIntroVideo": false, "step": 2 }, "schema": { "additionalProperties": false, "description": "Lists the wizard state properties.", "properties": { "playIntroVideo": { "description": "Marks the introduction video as played.", "type": "boolean" }, "step": { "description": "Indicates the last step completed in the wizard.", "minimum": 0, "type": "integer" }, "videoLink": { "description": "The link to the introduction video.", "minLength": 1, "type": "string" } }, "required": [ "playIntroVideo", "step" ], "type": "object", "x-akamai": { "file-path": "schemas/first-time-wizard-get-state.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Update the first time wizard", "tags": [ "Configuration wizard" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/first-time-wizard.yaml", "path-info": "/configs/{configId}/firstTimeWizard" } }, "/configs/{configId}/global-settings": { "get": { "description": "Provides global settings details.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-global-settings" }, "operationId": "get-global-settings", "parameters": [ { "description": "Includes source IP binding CIDRs in the result set.", "in": "query", "name": "includeSourceIpCidrs", "required": false, "schema": { "default": true, "example": false, "type": "boolean" }, "x-akamai": { "file-path": "parameters/include-sourceipbind.yaml" } }, { "description": "Identifies each contract.", "in": "query", "name": "contractId", "required": false, "schema": { "example": "K-0N7RAK7", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id.yaml" } }, { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "asnExceptions": [ 20, 10, 30 ], "blockRoamingTraffic": true, "createdBy": "alfulani", "createdDate": "2018-03-05T17:10:33.849+0000", "enableSourceIpBind": true, "modifiedBy": "mrossi@sia.com", "modifiedDate": "2020-08-06T23:23:22.014+0000", "quicklistMigrated": true, "sourceIpBindCidrs": [ "192.0.2.28" ] }, "schema": { "additionalProperties": false, "description": "Provides global settings details.", "properties": { "asnExceptions": { "description": "AS number exceptions.", "items": { "description": "AS number.", "maximum": 4294967294, "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array", "uniqueItems": true }, "blockRoamingTraffic": { "description": "Blocks roaming traffic.", "type": "boolean" }, "chinaDeploymentStatus": { "description": "The status of the China region deployment. Refer to [Deployment status](https://techdocs.akamai.com/etp-config/reference/deployment-status) for more information. ", "enum": [ "STAGING", "PENDING", "BUILDING", "RUNNING", "COMPLETED", "CONTENT_EXTERNAL", "REVERTING", "FAILED", "ABORTED" ], "type": "string" }, "createdBy": { "description": "Name of the user who created this global setting.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp this global setting's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "enableChinaRegion": { "description": "Enables the China region for the deployment.", "type": "boolean" }, "enableSourceIpBind": { "description": "Enables source IP binding.", "type": "boolean" }, "globalSettingsId": { "description": "Unique ID of the global setting.", "minimum": 1, "type": "integer" }, "modifiedBy": { "description": "The user who modified this global setting.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this global setting's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "quicklistMigrated": { "description": "Migrates the quicklist.", "type": "boolean" }, "sourceIpBindCidrs": { "description": "IP CIDRs available for `sourceIpBind`.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "blockRoamingTraffic" ], "type": "object", "x-akamai": { "file-path": "schemas/global-settings-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get global settings", "tags": [ "Global settings" ] }, "put": { "description": "Updates the global settings.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-global-settings" }, "operationId": "put-global-settings", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "asnExceptions": [ 20, 10, 30 ], "blockRoamingTraffic": false, "enableSourceIpBind": true }, "schema": { "additionalProperties": false, "description": "Provides global settings details.", "properties": { "asnExceptions": { "description": "AS number exceptions.", "items": { "description": "AS number.", "maximum": 4294967294, "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array", "uniqueItems": true }, "blockRoamingTraffic": { "description": "Blocks roaming traffic.", "type": "boolean" }, "enableChinaRegion": { "description": "Enables the China region for the deployment.", "type": "boolean" }, "enableHttpsErrorPage": { "description": "Enables display of HTTPS block pages for DNS only policies.", "type": "boolean" }, "enableSourceIpBind": { "description": "Enables the source IP binding.", "type": "boolean" }, "globalSettingsId": { "description": "__Read-only__ The unique ID for the global setting.", "minimum": 1, "readOnly": true, "type": "integer" }, "quicklistMigrated": { "description": "Migrates `quickList`.", "type": "boolean" } }, "required": [ "blockRoamingTraffic" ], "type": "object", "x-akamai": { "file-path": "schemas/global-settings-update-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Update global settings", "tags": [ "Global settings" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/global-settings.yaml", "path-info": "/configs/{configId}/global-settings" } }, "/configs/{configId}/honeypots": { "post": { "description": "Creates a new custom response.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-custom-response" }, "operationId": "post-custom-response", "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": { "description": "new custom response for production", "ipv4Addrs": [ "192.0.2.118", "192.0.2.188" ], "ipv6Addrs": [ "2019:D30::88/124", "2021:D32::88/124" ], "name": "custom response prod" }, "schema": { "additionalProperties": false, "description": "Properties for a specific custom response.", "properties": { "aliases": { "description": "Aliases for the custom response.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "createdBy": { "description": "Name of the user who created this custom response.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking when this custom response was created.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "The description of the custom response.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ A unique identifier for each custom response. Use this value for a `honeypotId` parameter in subsequent operations.", "minimum": 1, "readOnly": true, "type": "integer" }, "ipv4Addrs": { "description": "IPv4 address of a target device.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "ipv6Addrs": { "description": "IPv6 address of a target device.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "modifiedBy": { "description": "Name of the user who most recently modified this custom response.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this custom response's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the custom response.", "minLength": 1, "type": "string" }, "policies": { "description": "Policies for the custom response.", "items": { "additionalProperties": false, "properties": { "id": { "description": "A unique identifier for each policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" } }, "required": [ "name", "description", "ipv4Addrs", "ipv6Addrs" ], "type": "object", "x-akamai": { "file-path": "schemas/honeypot-retrieve-specific.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "detail": "The name :Site11 is not unique. Code-090415", "instance": "6702ffa9-3d06-4c5d-a099-1f7e2759bea2", "status": 409, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-409.yaml" } } } }, "description": "[Conflict with current state of resource](https://techdocs.akamai.com/etp-config/reference/409). Use the `X-etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/conflict-409.yaml" } } }, "summary": "Create a custom response", "tags": [ "Custom responses" ] }, "get": { "description": "Returns all custom responses.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-custom-responses" }, "operationId": "get-custom-responses", "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": [ { "aliases": [ "abcd.com" ], "createdBy": "jsmith", "createdDate": "2017-07-18T16:20:49.967+0000", "description": "Custom Response", "id": 760, "ipv4Addrs": [ "192.0.2.182" ], "ipv6Addrs": [ "2019:D30::88/124", "2021:D32::88/124" ], "modifiedBy": "tyamada", "modifiedDate": "2020-05-12T18:42:50.716+0000", "name": "Sinkhole 1", "policies": [ { "id": 2480, "name": "Default" } ] }, { "aliases": [ "d-soni.com" ], "createdBy": "tyamada", "createdDate": "2020-07-21T13:25:25.555+0000", "description": "Dsoni", "id": 30807, "ipv4Addrs": [ "192.0.2.162" ], "ipv6Addrs": [ "2019:D30::88/124", "2021:D32::88/124" ], "modifiedBy": "szhang", "modifiedDate": "2020-07-21T13:25:25.562+0000", "name": "Dsoni", "policies": [ { "id": 2250, "name": "policy_3" } ] } ], "schema": { "description": "Honeypot properties.", "items": { "additionalProperties": false, "description": "Properties for a specific custom response.", "properties": { "aliases": { "description": "Aliases for the custom response.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "createdBy": { "description": "Name of the user who created this custom response.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking when this custom response was created.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "The description of the custom response.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ A unique identifier for each custom response. Use this value for a `honeypotId` parameter in subsequent operations.", "minimum": 1, "readOnly": true, "type": "integer" }, "ipv4Addrs": { "description": "IPv4 address of a target device.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "ipv6Addrs": { "description": "IPv6 address of a target device.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "modifiedBy": { "description": "Name of the user who most recently modified this custom response.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this custom response's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the custom response.", "minLength": 1, "type": "string" }, "policies": { "description": "Policies for the custom response.", "items": { "additionalProperties": false, "properties": { "id": { "description": "A unique identifier for each policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" } }, "required": [ "name", "description", "ipv4Addrs", "ipv6Addrs" ], "type": "object", "x-akamai": { "file-path": "schemas/honeypot-retrieve-specific.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/honeypot-retrieve-all.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List custom responses", "tags": [ "Custom responses" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/honeypots.yaml", "path-info": "/configs/{configId}/honeypots" } }, "/configs/{configId}/honeypots/{honeypotId}": { "get": { "description": "Returns the details of a specific custom response.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-custom-response" }, "operationId": "get-custom-response", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "aliases": [ "abcd.com" ], "createdBy": "jsmith", "createdDate": "2017-07-18T16:20:49.967+0000", "description": "Custom Response", "id": 760, "ipv4Addrs": [ "192.0.2.241" ], "ipv6Addrs": [ "2019:D30::88/124", "2021:D32::88/124" ], "modifiedBy": "tyamada", "modifiedDate": "2020-05-12T18:42:50.716+0000", "name": "Sinkhole 1", "policies": [ { "id": 2480, "name": "Default" } ] }, "schema": { "additionalProperties": false, "description": "Properties for a specific custom response.", "properties": { "aliases": { "description": "Aliases for the custom response.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "createdBy": { "description": "Name of the user who created this custom response.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking when this custom response was created.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "The description of the custom response.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ A unique identifier for each custom response. Use this value for a `honeypotId` parameter in subsequent operations.", "minimum": 1, "readOnly": true, "type": "integer" }, "ipv4Addrs": { "description": "IPv4 address of a target device.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "ipv6Addrs": { "description": "IPv6 address of a target device.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "modifiedBy": { "description": "Name of the user who most recently modified this custom response.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this custom response's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the custom response.", "minLength": 1, "type": "string" }, "policies": { "description": "Policies for the custom response.", "items": { "additionalProperties": false, "properties": { "id": { "description": "A unique identifier for each policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" } }, "required": [ "name", "description", "ipv4Addrs", "ipv6Addrs" ], "type": "object", "x-akamai": { "file-path": "schemas/honeypot-retrieve-specific.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get a custom response", "tags": [ "Custom responses" ] }, "put": { "description": "Modifies a custom response's features.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-custom-response" }, "operationId": "put-custom-response", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "updated custom response 2023", "ipv4Addrs": [ "192.0.2.36", "192.0.2.189" ], "ipv6Addrs": [ "2019:D30::88/124", "2021:D32::88/124" ], "name": "custom response prod" }, "schema": { "additionalProperties": false, "description": "Lists the custom response update properties.", "properties": { "aliases": { "description": "Aliases for the custom response.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "description": { "description": "Describes the custom response.", "minLength": 1, "type": "string" }, "ipv4Addrs": { "description": "Updates the IPv4 addresses for the custom response.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "ipv6Addrs": { "description": "Updates the IPv6 addresses for the custom response.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "name": { "description": "The custom response name.", "minLength": 1, "type": "string" }, "policies": { "description": "Policies for the custom response.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for each policy.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" } }, "required": [ "name", "description", "ipv4Addrs", "ipv6Addrs" ], "type": "object", "x-akamai": { "file-path": "schemas/honeypot-update.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Update a custom response", "tags": [ "Custom responses" ] }, "delete": { "description": "Deletes a specific custom response.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/delete-custom-response" }, "operationId": "delete-custom-response", "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": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Delete a custom response", "tags": [ "Custom responses" ] }, "parameters": [ { "description": "A unique identifier for a custom response.", "in": "path", "name": "honeypotId", "required": true, "schema": { "example": 1234, "type": "integer" }, "x-akamai": { "file-path": "parameters/honeypot-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/honeypot.yaml", "path-info": "/configs/{configId}/honeypots/{honeypotId}" } }, "/configs/{configId}/idp-groups-policy": { "post": { "description": "Creates a group-based policy mapping.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-group-policy" }, "operationId": "post-group-policy", "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": { "directoryId": "16", "groupPolicies": [ { "groups": [ "EMEA", "APAC" ], "order": 1, "policyId": 37490 }, { "groups": [ "prod", "staging" ], "order": 2, "policyId": 4120 } ], "idpId": "16" }, "schema": { "additionalProperties": true, "description": "Group-based policy mapping properties.", "properties": { "directoryId": { "description": "The unique directory ID in Enterprise Application Access to map the group policy to. Run the [List directories](https://techdocs.akamai.com/eaa-api/reference/get-directories) operation to view your directory IDs.", "type": "string" }, "groupPolicies": { "description": "Group policies.", "items": { "additionalProperties": false, "properties": { "groups": { "description": "The groups the policy mapping applies to.", "items": { "type": "string" }, "type": "array" }, "order": { "description": "The policy mapping priority order.", "type": "integer" }, "policyId": { "description": "The unique ID of the policy mapped to the group.", "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Policy information.", "properties": { "id": { "description": "The policy ID.", "type": "integer" }, "name": { "description": "The policy name.", "type": "string" } }, "type": "object" } }, "required": [ "order", "groups", "policyId" ], "type": "object" }, "type": "array", "x-akamai": { "file-path": "schemas/group-policies.yaml" } }, "idpId": { "description": "The unique IDP ID in Enterprise Application Access to map the group policy to. Run the [List IDPs](https://techdocs.akamai.com/eaa-api/reference/get-idps) operation to view your IDP IDs.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/create-update-group-policy-mapping-body.yaml" } } } }, "required": true }, "responses": { "201": { "content": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } } }, "summary": "Create a group-based policy mapping", "tags": [ "User and group-based policies" ] }, "get": { "description": "Returns all group-based policies.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-group-policy-mappings" }, "operationId": "get-group-policy-mappings", "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": [ { "directoryId": "15", "groupPolicies": [ { "groups": [ "EMEA", "APAC" ], "order": 1, "policyId": 37490, "policyInfo": { "id": 37490 } }, { "groups": [ "prod", "staging" ], "order": 2, "policyId": 4120, "policyInfo": { "id": 4120, "name": "P1" } } ], "idpGroupPolicyId": 181, "idpId": "15", "modifiedBy": "jkowalski", "modifiedDate": "2023-10-26T12:09:31.000+00:00" } ], "schema": { "description": "Group based policy properties.", "items": { "additionalProperties": true, "description": "Group based policy properties.", "properties": { "directoryId": { "description": "The unique directory ID in Enterprise Application Access to map the group policy to. Run the [List directories](https://techdocs.akamai.com/eaa-api/reference/get-directories) operation to view your directory IDs.", "type": "string" }, "groupPolicies": { "description": "Group policy properties.", "items": { "additionalProperties": false, "properties": { "groups": { "description": "The groups the policy mapping applies to.", "items": { "type": "string" }, "type": "array" }, "order": { "description": "The policy mapping priority order.", "type": "integer" }, "policyId": { "description": "The unique ID of the policy mapped to the group.", "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Policy information.", "properties": { "id": { "description": "The policy ID.", "type": "integer" }, "name": { "description": "The policy name.", "type": "string" } }, "type": "object" } }, "required": [ "order", "groups", "policyId" ], "type": "object" }, "type": "array", "x-akamai": { "file-path": "schemas/group-policies.yaml" } }, "idpGroupPolicyId": { "description": "The unique group policy mapping ID.", "type": "integer" }, "idpId": { "description": "The unique IDP ID in Enterprise Application Access to map the group policy to. Run the [List IDPs](https://techdocs.akamai.com/eaa-api/reference/get-idps) operation to view your IDP IDs.", "type": "string" }, "modifiedBy": { "description": "The user who made the last modification.", "type": "string" }, "modifiedDate": { "description": "Timestamp marking the last modification.", "type": "string" } }, "type": "object" }, "minItems": 1, "type": "array", "x-akamai": { "file-path": "schemas/get-group-policy-mappings-200.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } } }, "summary": "List group-based policy mappings", "tags": [ "User and group-based policies" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/user-group-based-policy.yaml", "path-info": "/configs/{configId}/idp-groups-policy" } }, "/configs/{configId}/idp-groups-policy/for-idp/{idpId}": { "delete": { "description": "Deletes all group policy mappings for an IDP.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/delete-group-policies-for-idp" }, "operationId": "delete-group-policies-for-idp", "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": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Delete all group policy mappings for an IDP", "tags": [ "User and group-based policies" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } }, { "description": "A unique identifier for the IDP from EAA.", "in": "path", "name": "idpId", "required": true, "schema": { "example": "ojxkXzwyQZiBkoRee0XcnA", "type": "string" }, "x-akamai": { "file-path": "parameters/idp-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/user-group-policies-delete.yaml", "path-info": "/configs/{configId}/idp-groups-policy/for-idp/{idpId}" } }, "/configs/{configId}/idp-groups-policy/{idpGroupPolicyId}": { "get": { "description": "Gets a group-based policy mapping.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-group-policy" }, "operationId": "get-group-policy", "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": { "directoryId": "15", "groupPolicies": [ { "groups": [ "EMEA", "APAM" ], "order": 2, "policyId": 4120, "policyInfo": { "id": 4120, "name": "P1" } }, { "groups": [ "prod", "staging" ], "order": 1, "policyId": 37490, "policyInfo": { "id": 37490 } } ], "idpGroupPolicyId": 181, "idpId": "15", "modifiedBy": "hgildong", "modifiedDate": "2023-10-26T12:11:11.600+00:00" }, "schema": { "additionalProperties": true, "properties": { "directoryId": { "description": "The unique directory ID in Enterprise Application Access to map the group policy to. Run the [List directories](https://techdocs.akamai.com/eaa-api/reference/get-directories) operation to view your directory IDs.", "type": "string" }, "groupPolicies": { "description": "Group policy properties.", "items": { "additionalProperties": false, "properties": { "groups": { "description": "The groups the policy mapping applies to.", "items": { "type": "string" }, "type": "array" }, "order": { "description": "The policy mapping priority order.", "type": "integer" }, "policyId": { "description": "The unique ID of the policy mapped to the group.", "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Policy information.", "properties": { "id": { "description": "The policy ID.", "type": "integer" }, "name": { "description": "The policy name.", "type": "string" } }, "type": "object" } }, "required": [ "order", "groups", "policyId" ], "type": "object" }, "type": "array", "x-akamai": { "file-path": "schemas/group-policies.yaml" } }, "idpGroupPolicyId": { "description": "The unique group policy mapping ID.", "type": "integer" }, "idpId": { "description": "The unique IDP ID in Enterprise Application Access to map the group policy to. Run the [List IDPs](https://techdocs.akamai.com/eaa-api/reference/get-idps) operation to view your IDP IDs.", "type": "string" }, "modifiedBy": { "description": "The user who made the last modification.", "type": "string" }, "modifiedDate": { "description": "Timestamp marking the last modification.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-group-policy-mapping-200.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get a group-based policy mapping", "tags": [ "User and group-based policies" ] }, "put": { "description": "Update a group-based policy mapping.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-group-policy" }, "operationId": "put-group-policy", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "directoryId": "16", "groupPolicies": [ { "groups": [ "EMEA", "APAC" ], "order": 1, "policyId": 37490 }, { "groups": [ "prod", "staging" ], "order": 2, "policyId": 4120 } ], "idpId": "16" }, "schema": { "additionalProperties": true, "description": "Group-based policy mapping properties.", "properties": { "directoryId": { "description": "The unique directory ID in Enterprise Application Access to map the group policy to. Run the [List directories](https://techdocs.akamai.com/eaa-api/reference/get-directories) operation to view your directory IDs.", "type": "string" }, "groupPolicies": { "description": "Group policies.", "items": { "additionalProperties": false, "properties": { "groups": { "description": "The groups the policy mapping applies to.", "items": { "type": "string" }, "type": "array" }, "order": { "description": "The policy mapping priority order.", "type": "integer" }, "policyId": { "description": "The unique ID of the policy mapped to the group.", "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Policy information.", "properties": { "id": { "description": "The policy ID.", "type": "integer" }, "name": { "description": "The policy name.", "type": "string" } }, "type": "object" } }, "required": [ "order", "groups", "policyId" ], "type": "object" }, "type": "array", "x-akamai": { "file-path": "schemas/group-policies.yaml" } }, "idpId": { "description": "The unique IDP ID in Enterprise Application Access to map the group policy to. Run the [List IDPs](https://techdocs.akamai.com/eaa-api/reference/get-idps) operation to view your IDP IDs.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/create-update-group-policy-mapping-body.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Update a group-based policy mapping", "tags": [ "User and group-based policies" ] }, "delete": { "description": "Deletes a group-based policy mapping.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/delete-group-policy" }, "operationId": "delete-group-policy", "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": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Delete a group-based policy mapping", "tags": [ "User and group-based policies" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } }, { "description": "A unique identifier for the IDP group based policy.", "in": "path", "name": "idpGroupPolicyId", "required": true, "schema": { "example": 34, "type": "integer" }, "x-akamai": { "file-path": "parameters/idp-group-policy-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/user-group-based-policy-by-id.yaml", "path-info": "/configs/{configId}/idp-groups-policy/{idpGroupPolicyId}" } }, "/configs/{configId}/lists": { "post": { "description": "Creates a new list.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-list" }, "operationId": "post-list", "parameters": [ { "description": "Indicates if the result set includes deleted resources, `false` by default.", "in": "query", "name": "includeDeleted", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/include-deleted.yaml" } }, { "description": "Indicates if the results include special entities, `false` by default.", "in": "query", "name": "includeSpecialEntities", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/include-special-entities.yaml" } }, { "description": "Indicates if the results include resources with granted access, `false` by default.", "in": "query", "name": "onlyWithGrantedAccess", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/only-with-granted-access.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "List to block banking info phishing", "name": "Banking", "securityCategoryId": 1 }, "schema": { "additionalProperties": false, "description": "Describes list creation properties.", "properties": { "description": { "description": "Describes the list.", "minLength": 1, "type": "string" }, "listType": { "description": "The list type. See [List types](https://techdocs.akamai.com/etp-config/reference/list-types) for details on supported values.", "enum": [ "UNIFIED_BLOCK_LIST", "UNIFIED_EXCEPTION_LIST", "FQDN_LIST", "AKAMAI", "TOP_LEVEL_DOMAIN", "WHITELIST", "FILEHASHLIST", "FILEHASH_BLOCK", "DOMAIN_IP_LIST", "URL_BLOCK", "URL_BYPASS" ], "minLength": 0, "type": "string" }, "name": { "description": "Name of the list.", "minLength": 1, "type": "string" }, "securityCategoryId": { "description": "The list's security category value. Either 1 for Malware, 2 for Phishing, 3 for C&C, 5 for DNS Exfiltration, 6 for Risky domains, or 7 for File sharing.", "minimum": 1, "type": "integer" } }, "required": [ "name", "description", "securityCategoryId" ], "type": "object", "x-akamai": { "file-path": "schemas/list-create.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Create a list", "tags": [ "Lists" ] }, "get": { "description": "Returns all available custom security lists.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-lists" }, "operationId": "get-lists", "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": [ { "accessConfig": { "configurable": true, "delegatedAdmins": [ "delegatedUser@org.com" ], "readable": true }, "allowedForDnsPolicy": true, "createdBy": "adevi", "createdDate": "2017-06-27T21:07:20.443+0000", "description": "Costa Rica WB", "id": 3785, "itemCount": 6, "knownCounts": { "domains": 3, "fileHashes": 0, "ips": 2 }, "modifiedBy": "mrossi", "modifiedDate": "2020-06-10T20:39:04.386+0000", "name": "Costa Rica WB", "policySecuritySettings": [ { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 6942, "listInfo": { "categoryId": 1, "id": 6942, "name": "priya_" }, "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 760, "suspectedResponseInfo": { "id": 760, "name": "Sinkhole 1" } } ], "securityCategoryId": 1, "securityCategoryInfo": { "id": 1, "name": "Malware" }, "suspectedCounts": { "domains": 1, "ips": 0 } }, { "accessConfig": { "configurable": true, "delegatedAdmins": [ "delegatedUser@org.com" ], "readable": true }, "allowedForDnsPolicy": true, "createdBy": "jsmith", "createdDate": "2017-08-24T15:46:32.204+0000", "description": "LNS", "id": 4541, "itemCount": 3, "knownCounts": { "domains": 3, "fileHashes": 0, "ips": 0 }, "modifiedBy": "jperez", "modifiedDate": "2019-12-06T12:51:30.990+0000", "name": "Mchantor_LNS_List", "policySecuritySettings": [ { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 6942, "listInfo": { "categoryId": 1, "id": 6942, "name": "priya_" }, "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 760, "suspectedResponseInfo": { "id": 760, "name": "Sinkhole 1" } } ], "securityCategoryId": 4, "securityCategoryInfo": { "id": 4, "name": "Other" }, "suspectedCounts": { "domains": 0, "ips": 0 } } ], "schema": { "description": "Contains a custom security list of domains and IP addresses, with a confidence level for each.", "items": { "additionalProperties": false, "description": "A custom security list of domains and IP addresses, with a confidence level for each.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access config details.", "properties": { "configurable": { "description": "Marks the list as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated admins for the list.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks the list as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "allowedForDnsPolicy": { "description": "Allows the list per DNS policy.", "type": "boolean" }, "createdBy": { "description": "Name of the user who created this list.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this list's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "A description of the list that you provide.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ A unique identifier for each list. Use this value for a `listId` parameter in subsequent operations.", "minimum": 1, "readOnly": true, "type": "integer" }, "itemCount": { "description": "The number of entries in a list.", "minimum": 0, "type": "integer" }, "knownCounts": { "additionalProperties": false, "description": "Contains data of known counts.", "properties": { "domains": { "description": "The number of known domain entries in the list.", "minimum": 0, "type": "integer" }, "fileHashes": { "description": "The number of known file hashes in the list.", "minimum": 0, "type": "integer" }, "ips": { "description": "The number of known IP addresses in the list.", "minimum": 0, "type": "integer" } }, "required": [ "domains", "ips" ], "type": "object" }, "modifiedBy": { "description": "Name of the user who most recently modified the list.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this list's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the list.", "minLength": 1, "type": "string" }, "policySecuritySettings": { "description": "Lists the security settings applied to the policy.", "items": { "additionalProperties": false, "description": "V2 policy security settings.", "properties": { "confirmedGroups": { "description": "Confirmed groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "confirmedResponseId": { "description": "A unique identifier for the confirmed response.", "minimum": 1, "type": "integer" }, "confirmedResponseInfo": { "additionalProperties": false, "description": "Contains data about the confirmed response.", "properties": { "id": { "description": "A unique identifier for the confirmed response info.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the confirmed response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "confirmedUsers": { "description": "Confirmed users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "listId": { "description": "A unique identifier for the list.", "minimum": 1, "type": "integer" }, "listInfo": { "additionalProperties": false, "description": "Contains data about the list.", "properties": { "categoryId": { "description": "The unique category ID.", "minimum": 1, "type": "integer" }, "id": { "description": "A unique identifier for the list info.", "minimum": 1, "type": "integer" }, "listType": { "description": "The list type. See [List types](https://techdocs.akamai.com/etp-config/reference/list-types) for details on supported values.", "enum": [ "UNIFIED_BLOCK_LIST", "UNIFIED_EXCEPTION_LIST", "FQDN_LIST", "AKAMAI", "TOP_LEVEL_DOMAIN", "WHITELIST", "FILEHASHLIST", "FILEHASH_BLOCK", "DOMAIN_IP_LIST", "URL_BLOCK", "URL_BYPASS" ], "type": "string" }, "name": { "description": "The name of the list info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "categoryId" ], "type": "object" }, "policyId": { "description": "__Read-only__ Identifies the policy for the security setting.", "minimum": 1, "readOnly": true, "type": "integer" }, "policyName": { "description": "Name of the policy for the security setting.", "minLength": 1, "type": "string" }, "responseOverridesConfirmed": { "description": "Response overrides for confirmed response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "responseOverridesSuspected": { "description": "Response overrides for suspected response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "shouldNotifyConfirmed": { "description": "Send alert on confirmed list hit.", "type": "boolean" }, "shouldNotifySuspected": { "description": "Send alert on suspected list hit.", "type": "boolean" }, "suspectedGroups": { "description": "Suspected groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "suspectedResponseId": { "description": "__Read-only__ A unique identifier for the suspected response.", "minimum": 1, "readOnly": true, "type": "integer" }, "suspectedResponseInfo": { "additionalProperties": false, "description": "Suspected response data.", "properties": { "id": { "description": "A unique identifier for the suspected response info.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the suspected response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "suspectedUsers": { "description": "Suspected users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "listId", "confirmedResponseId", "shouldNotifyConfirmed", "shouldNotifySuspected" ], "type": "object", "x-akamai": { "file-path": "schemas/security-settings-info-v2.yaml" } }, "minItems": 0, "type": "array" }, "remainingCount": { "description": "The number of remaining entries for all lists globally.", "minimum": 0, "type": "integer" }, "securityCategoryId": { "description": "__Read-only__ The unique ID for the security category.", "minimum": 1, "readOnly": true, "type": "integer" }, "securityCategoryInfo": { "additionalProperties": false, "description": "Specifies the security category.", "properties": { "id": { "description": "A unique identifier for the security category.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the security category.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "suspectedCounts": { "additionalProperties": false, "description": "The count of suspected domain entries in the list.", "properties": { "domains": { "description": "The number of suspected domains in the list.", "minimum": 0, "type": "integer" }, "ips": { "description": "The number of suspected IP addresses in the list.", "minimum": 0, "type": "integer" } }, "required": [ "domains", "ips" ], "type": "object" } }, "required": [ "name", "securityCategoryId", "description" ], "type": "object", "x-akamai": { "file-path": "schemas/list-retrieve-specific.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/list-retrieve-all.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List all lists", "tags": [ "Lists" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/lists.yaml", "path-info": "/configs/{configId}/lists" } }, "/configs/{configId}/lists/quota": { "get": { "description": "Returns the remaining list item quota for all lists globally.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-lists-quota" }, "operationId": "get-lists-quota", "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": { "count": 1000, "remainingCount": 990 }, "schema": { "additionalProperties": false, "description": "This object returns the global count of entries in all lists and the entries available to configure.", "properties": { "count": { "description": "The total number of list items currently in your configuration.", "minimum": 0, "type": "integer" }, "remainingCount": { "description": "The remaining number of list items that you can add to your configuration.", "minimum": 0, "type": "integer" } }, "required": [ "count", "remainingCount" ], "type": "object", "x-akamai": { "file-path": "schemas/list-get-global-quota.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List global list quotas", "tags": [ "Lists" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/quota.yaml", "path-info": "/configs/{configId}/lists/quota" } }, "/configs/{configId}/lists/{listId}": { "get": { "description": "Returns the details of a specific list.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-list" }, "operationId": "get-list", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "accessConfig": { "configurable": true, "delegatedAdmins": [ "delegatedUser@org.com" ], "readable": true }, "allowedForDnsPolicy": true, "createdBy": "adevi", "createdDate": "2017-06-27T21:07:20.443+0000", "description": "Costa Rica WB", "id": 3785, "itemCount": 6, "knownCounts": { "domains": 3, "ips": 2 }, "modifiedBy": "alfulani", "modifiedDate": "2020-06-10T20:39:04.386+0000", "name": "Costa Rica WB", "policySecuritySettings": [ { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 3785, "policyId": 2480, "policyName": "Default", "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 1, "suspectedResponseInfo": { "id": 1, "name": "Monitor" } }, { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 3785, "policyId": 84715, "policyName": "NewPWithD", "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 1, "suspectedResponseInfo": { "id": 1, "name": "Monitor" } }, { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 3785, "policyId": 82601, "policyName": "policy_11", "shouldNotifyConfirmed": true, "shouldNotifySuspected": true, "suspectedResponseId": 1, "suspectedResponseInfo": { "id": 1, "name": "Monitor" } } ], "securityCategoryId": 1, "securityCategoryInfo": { "id": 1, "name": "Malware" }, "suspectedCounts": { "domains": 1, "ips": 0 } }, "schema": { "additionalProperties": false, "description": "A custom security list of domains and IP addresses, with a confidence level for each.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access config details.", "properties": { "configurable": { "description": "Marks the list as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated admins for the list.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks the list as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "allowedForDnsPolicy": { "description": "Allows the list per DNS policy.", "type": "boolean" }, "createdBy": { "description": "Name of the user who created this list.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this list's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "A description of the list that you provide.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ A unique identifier for each list. Use this value for a `listId` parameter in subsequent operations.", "minimum": 1, "readOnly": true, "type": "integer" }, "itemCount": { "description": "The number of entries in a list.", "minimum": 0, "type": "integer" }, "knownCounts": { "additionalProperties": false, "description": "Contains data of known counts.", "properties": { "domains": { "description": "The number of known domain entries in the list.", "minimum": 0, "type": "integer" }, "fileHashes": { "description": "The number of known file hashes in the list.", "minimum": 0, "type": "integer" }, "ips": { "description": "The number of known IP addresses in the list.", "minimum": 0, "type": "integer" } }, "required": [ "domains", "ips" ], "type": "object" }, "modifiedBy": { "description": "Name of the user who most recently modified the list.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this list's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the list.", "minLength": 1, "type": "string" }, "policySecuritySettings": { "description": "Lists the security settings applied to the policy.", "items": { "additionalProperties": false, "description": "V2 policy security settings.", "properties": { "confirmedGroups": { "description": "Confirmed groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "confirmedResponseId": { "description": "A unique identifier for the confirmed response.", "minimum": 1, "type": "integer" }, "confirmedResponseInfo": { "additionalProperties": false, "description": "Contains data about the confirmed response.", "properties": { "id": { "description": "A unique identifier for the confirmed response info.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the confirmed response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "confirmedUsers": { "description": "Confirmed users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "listId": { "description": "A unique identifier for the list.", "minimum": 1, "type": "integer" }, "listInfo": { "additionalProperties": false, "description": "Contains data about the list.", "properties": { "categoryId": { "description": "The unique category ID.", "minimum": 1, "type": "integer" }, "id": { "description": "A unique identifier for the list info.", "minimum": 1, "type": "integer" }, "listType": { "description": "The list type. See [List types](https://techdocs.akamai.com/etp-config/reference/list-types) for details on supported values.", "enum": [ "UNIFIED_BLOCK_LIST", "UNIFIED_EXCEPTION_LIST", "FQDN_LIST", "AKAMAI", "TOP_LEVEL_DOMAIN", "WHITELIST", "FILEHASHLIST", "FILEHASH_BLOCK", "DOMAIN_IP_LIST", "URL_BLOCK", "URL_BYPASS" ], "type": "string" }, "name": { "description": "The name of the list info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "categoryId" ], "type": "object" }, "policyId": { "description": "__Read-only__ Identifies the policy for the security setting.", "minimum": 1, "readOnly": true, "type": "integer" }, "policyName": { "description": "Name of the policy for the security setting.", "minLength": 1, "type": "string" }, "responseOverridesConfirmed": { "description": "Response overrides for confirmed response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "responseOverridesSuspected": { "description": "Response overrides for suspected response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "shouldNotifyConfirmed": { "description": "Send alert on confirmed list hit.", "type": "boolean" }, "shouldNotifySuspected": { "description": "Send alert on suspected list hit.", "type": "boolean" }, "suspectedGroups": { "description": "Suspected groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "suspectedResponseId": { "description": "__Read-only__ A unique identifier for the suspected response.", "minimum": 1, "readOnly": true, "type": "integer" }, "suspectedResponseInfo": { "additionalProperties": false, "description": "Suspected response data.", "properties": { "id": { "description": "A unique identifier for the suspected response info.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the suspected response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "suspectedUsers": { "description": "Suspected users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "listId", "confirmedResponseId", "shouldNotifyConfirmed", "shouldNotifySuspected" ], "type": "object", "x-akamai": { "file-path": "schemas/security-settings-info-v2.yaml" } }, "minItems": 0, "type": "array" }, "remainingCount": { "description": "The number of remaining entries for all lists globally.", "minimum": 0, "type": "integer" }, "securityCategoryId": { "description": "__Read-only__ The unique ID for the security category.", "minimum": 1, "readOnly": true, "type": "integer" }, "securityCategoryInfo": { "additionalProperties": false, "description": "Specifies the security category.", "properties": { "id": { "description": "A unique identifier for the security category.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the security category.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "suspectedCounts": { "additionalProperties": false, "description": "The count of suspected domain entries in the list.", "properties": { "domains": { "description": "The number of suspected domains in the list.", "minimum": 0, "type": "integer" }, "ips": { "description": "The number of suspected IP addresses in the list.", "minimum": 0, "type": "integer" } }, "required": [ "domains", "ips" ], "type": "object" } }, "required": [ "name", "securityCategoryId", "description" ], "type": "object", "x-akamai": { "file-path": "schemas/list-retrieve-specific.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get details of a list", "tags": [ "Lists" ] }, "put": { "description": "Modifies list properties and all items for a specific list. Full update only.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-config-list" }, "operationId": "put-config-list", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "Indicates if the result set includes deleted resources, `false` by default.", "in": "query", "name": "includeDeleted", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/include-deleted.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "accessConfig": { "configurable": true, "delegatedAdmins": [ "delegatedUser@org.com" ], "readable": true }, "allowedForDnsPolicy": true, "createdBy": "adevi", "createdDate": "2017-06-27T21:07:20.443+0000", "description": "Costa Rica WB", "id": 3785, "itemCount": 6, "knownCounts": { "domains": 3, "ips": 2 }, "modifiedBy": "alfulani", "modifiedDate": "2020-06-10T20:39:04.386+0000", "name": "Costa Rica WB", "policySecuritySettings": [ { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 3785, "policyId": 2480, "policyName": "Default", "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 1, "suspectedResponseInfo": { "id": 1, "name": "Monitor" } }, { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 3785, "policyId": 84715, "policyName": "NewPWithD", "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 1, "suspectedResponseInfo": { "id": 1, "name": "Monitor" } }, { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 3785, "policyId": 82601, "policyName": "policy_11", "shouldNotifyConfirmed": true, "shouldNotifySuspected": true, "suspectedResponseId": 1, "suspectedResponseInfo": { "id": 1, "name": "Monitor" } } ], "securityCategoryId": 1, "securityCategoryInfo": { "id": 1, "name": "Malware" }, "suspectedCounts": { "domains": 1, "ips": 0 } }, "schema": { "additionalProperties": false, "description": "A custom security list of domains and IP addresses, with a confidence level for each.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access config details.", "properties": { "configurable": { "description": "Marks the list as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated admins for the list.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks the list as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "allowedForDnsPolicy": { "description": "Allows the list per DNS policy.", "type": "boolean" }, "createdBy": { "description": "Name of the user who created this list.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this list's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "A description of the list that you provide.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ A unique identifier for each list. Use this value for a `listId` parameter in subsequent operations.", "minimum": 1, "readOnly": true, "type": "integer" }, "itemCount": { "description": "The number of entries in a list.", "minimum": 0, "type": "integer" }, "knownCounts": { "additionalProperties": false, "description": "Contains data of known counts.", "properties": { "domains": { "description": "The number of known domain entries in the list.", "minimum": 0, "type": "integer" }, "fileHashes": { "description": "The number of known file hashes in the list.", "minimum": 0, "type": "integer" }, "ips": { "description": "The number of known IP addresses in the list.", "minimum": 0, "type": "integer" } }, "required": [ "domains", "ips" ], "type": "object" }, "modifiedBy": { "description": "Name of the user who most recently modified the list.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this list's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the list.", "minLength": 1, "type": "string" }, "policySecuritySettings": { "description": "Lists the security settings applied to the policy.", "items": { "additionalProperties": false, "description": "V2 policy security settings.", "properties": { "confirmedGroups": { "description": "Confirmed groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "confirmedResponseId": { "description": "A unique identifier for the confirmed response.", "minimum": 1, "type": "integer" }, "confirmedResponseInfo": { "additionalProperties": false, "description": "Contains data about the confirmed response.", "properties": { "id": { "description": "A unique identifier for the confirmed response info.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the confirmed response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "confirmedUsers": { "description": "Confirmed users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "listId": { "description": "A unique identifier for the list.", "minimum": 1, "type": "integer" }, "listInfo": { "additionalProperties": false, "description": "Contains data about the list.", "properties": { "categoryId": { "description": "The unique category ID.", "minimum": 1, "type": "integer" }, "id": { "description": "A unique identifier for the list info.", "minimum": 1, "type": "integer" }, "listType": { "description": "The list type. See [List types](https://techdocs.akamai.com/etp-config/reference/list-types) for details on supported values.", "enum": [ "UNIFIED_BLOCK_LIST", "UNIFIED_EXCEPTION_LIST", "FQDN_LIST", "AKAMAI", "TOP_LEVEL_DOMAIN", "WHITELIST", "FILEHASHLIST", "FILEHASH_BLOCK", "DOMAIN_IP_LIST", "URL_BLOCK", "URL_BYPASS" ], "type": "string" }, "name": { "description": "The name of the list info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "categoryId" ], "type": "object" }, "policyId": { "description": "__Read-only__ Identifies the policy for the security setting.", "minimum": 1, "readOnly": true, "type": "integer" }, "policyName": { "description": "Name of the policy for the security setting.", "minLength": 1, "type": "string" }, "responseOverridesConfirmed": { "description": "Response overrides for confirmed response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "responseOverridesSuspected": { "description": "Response overrides for suspected response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "shouldNotifyConfirmed": { "description": "Send alert on confirmed list hit.", "type": "boolean" }, "shouldNotifySuspected": { "description": "Send alert on suspected list hit.", "type": "boolean" }, "suspectedGroups": { "description": "Suspected groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "suspectedResponseId": { "description": "__Read-only__ A unique identifier for the suspected response.", "minimum": 1, "readOnly": true, "type": "integer" }, "suspectedResponseInfo": { "additionalProperties": false, "description": "Suspected response data.", "properties": { "id": { "description": "A unique identifier for the suspected response info.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the suspected response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "suspectedUsers": { "description": "Suspected users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "listId", "confirmedResponseId", "shouldNotifyConfirmed", "shouldNotifySuspected" ], "type": "object", "x-akamai": { "file-path": "schemas/security-settings-info-v2.yaml" } }, "minItems": 0, "type": "array" }, "remainingCount": { "description": "The number of remaining entries for all lists globally.", "minimum": 0, "type": "integer" }, "securityCategoryId": { "description": "__Read-only__ The unique ID for the security category.", "minimum": 1, "readOnly": true, "type": "integer" }, "securityCategoryInfo": { "additionalProperties": false, "description": "Specifies the security category.", "properties": { "id": { "description": "A unique identifier for the security category.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the security category.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "suspectedCounts": { "additionalProperties": false, "description": "The count of suspected domain entries in the list.", "properties": { "domains": { "description": "The number of suspected domains in the list.", "minimum": 0, "type": "integer" }, "ips": { "description": "The number of suspected IP addresses in the list.", "minimum": 0, "type": "integer" } }, "required": [ "domains", "ips" ], "type": "object" } }, "required": [ "name", "securityCategoryId", "description" ], "type": "object", "x-akamai": { "file-path": "schemas/list-retrieve-specific.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Update a list", "tags": [ "Lists" ] }, "delete": { "description": "Deletes a specific list.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/delete-config-list" }, "operationId": "delete-config-list", "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": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "detail": "The name :Site11 is not unique. Code-090415", "instance": "6702ffa9-3d06-4c5d-a099-1f7e2759bea2", "status": 409, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-409.yaml" } } } }, "description": "[Conflict with current state of resource](https://techdocs.akamai.com/etp-config/reference/409). Use the `X-etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/conflict-409.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Remove a list", "tags": [ "Lists" ] }, "parameters": [ { "description": "A unique identifier for the list.", "in": "path", "name": "listId", "required": true, "schema": { "example": 3785, "type": "integer" }, "x-akamai": { "file-path": "parameters/list-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/list.yaml", "path-info": "/configs/{configId}/lists/{listId}" } }, "/configs/{configId}/lists/{listId}/items": { "get": { "description": "Filters items in a list by search parameters.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-config-lists-items" }, "operationId": "get-config-lists-items", "parameters": [ { "description": "__Enum__ The threat confidence level of the list item. Use `1` for a suspected item and `2` for a known item. `0` is the default, and indicates an unknown confidence level for the list item.", "in": "query", "name": "confidence", "schema": { "default": 0, "enum": [ 0, 1, 2 ], "example": 2, "type": "integer" }, "x-akamai": { "file-path": "parameters/confidence.yaml" } }, { "description": "The number of items per page, 50 by default.", "in": "query", "name": "numItemsPerPage", "schema": { "default": 50, "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/num-items-per-page.yaml" } }, { "description": "The page number to fetch, `0` by default.", "in": "query", "name": "page", "schema": { "default": 0, "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/page.yaml" } }, { "description": "Search for the string within the results.", "in": "query", "name": "search", "schema": { "example": "192.0.2.163", "type": "string" }, "x-akamai": { "file-path": "parameters/search.yaml" } }, { "description": "__Enum__ The target list type to search.", "in": "query", "name": "type", "schema": { "enum": [ "LIST_TYPE_IP", "LIST_TYPE_DOMAIN", "LIST_TYPE_INVALID", "LIST_TYPE_FILEHASH", "URL" ], "example": "LIST_TYPE_IP", "type": "string" }, "x-akamai": { "file-path": "parameters/type.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "items": [ { "confidenceLevelId": 1, "type": "LIST_TYPE_IP", "value": "192.0.2.0" } ], "totalCount": 200 }, "schema": { "additionalProperties": true, "description": "Details of list items from the search result set.", "properties": { "items": { "description": "Custom lists matching the search criteria.", "items": { "additionalProperties": false, "properties": { "confidenceLevelId": { "description": "The list item's threat confidence level. `1` indicates a suspected item. `2` indicates a known item. `0` indicates an unknown confidence level. A confidence level of `1` supports all types of list items, while `2` supports only IP addresses and domain types.", "enum": [ 1, 2, 0 ], "type": "integer" }, "type": { "description": "The list item type, either `LIST_TYPE_IP` for an IP address, or `LIST_TYPE_DOMAIN` for a domain.", "enum": [ "LIST_TYPE_IP", "LIST_TYPE_DOMAIN" ], "minLength": 1, "type": "string" }, "value": { "description": "The IP address or domain of the list item.", "minLength": 1, "type": "string" } }, "required": [ "type", "value", "confidenceLevelId" ], "type": "object" }, "minItems": 0, "type": "array" }, "totalCount": { "description": "The total number of list items.", "minimum": 0, "type": "integer" } }, "required": [ "items" ], "type": "object", "x-akamai": { "file-path": "schemas/list-retrieve-by-search.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "detail": "The name :Site11 is not unique. Code-090415", "instance": "6702ffa9-3d06-4c5d-a099-1f7e2759bea2", "status": 409, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-409.yaml" } } } }, "description": "[Conflict with current state of resource](https://techdocs.akamai.com/etp-config/reference/409). Use the `X-etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/conflict-409.yaml" } } }, "summary": "Search in a list", "tags": [ "Lists" ] }, "put": { "description": "Updates list items (overwrite).", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-config-lists-items" }, "operationId": "put-config-lists-items", "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": [ { "confidenceLevelId": 1, "type": "LIST_TYPE_IP", "value": "192.0.2.134" } ], "schema": { "description": "List set items.", "items": { "additionalProperties": false, "description": "This object provides details for a list entry.", "properties": { "confidenceLevelId": { "description": "The threat confidence level of the list item. Use `1` for a suspected item and `2` for a known item. `0` indicates an unknown confidence level for this item.", "enum": [ 1, 2, 0 ], "type": "integer" }, "type": { "description": "The list item type. Either `LIST_TYPE_IP`, `LIST_TYPE_DOMAIN`, `LIST_TYPE_FILEHASH`, or `URL`.", "enum": [ "LIST_TYPE_IP", "LIST_TYPE_DOMAIN", "LIST_TYPE_FILEHASH", "URL" ], "type": "string" }, "value": { "description": "The IP address or domain of the list item.", "minLength": 1, "type": "string" } }, "required": [ "type", "value", "confidenceLevelId" ], "type": "object", "x-akamai": { "file-path": "schemas/listset-items-content.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/list-set-items-all.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Modify list items", "tags": [ "Lists" ] }, "patch": { "description": "Modifies individual list items entries. Add or delete only.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/patch-config-list" }, "operationId": "patch-config-list", "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": { "delete": [ "192.0.2.47", "192.0.2.125" ], "add": [ { "confidenceLevelId": 2, "type": "LIST_TYPE_IP", "value": "192.0.2.208" } ] }, "schema": { "additionalProperties": true, "description": "Items to add or delete when performing a patch operation on a list.", "properties": { "delete": { "description": "An array of IP addresses, domains, URLs and file hashes to delete in the PATCH operation.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "add": { "description": "Contains details of the list item to add in the patch operation.", "items": { "additionalProperties": false, "properties": { "confidenceLevelId": { "description": "The threat confidence level of the list item. Use `1` for a suspected item and `2` for a known item. `0` indicates an unknown confidence level for this item.", "enum": [ 1, 2, 0 ], "type": "integer" }, "type": { "description": "The list item type. Either `LIST_TYPE_IP`, `LIST_TYPE_DOMAIN`, `LIST_TYPE_FILEHASH`, or `URL`.", "enum": [ "LIST_TYPE_IP", "LIST_TYPE_DOMAIN", "LIST_TYPE_FILEHASH", "URL" ], "type": "string" }, "value": { "description": "The IP address or domain of the list item.", "minLength": 1, "type": "string" } }, "required": [ "type", "value", "confidenceLevelId" ], "type": "object" }, "minItems": 0, "type": "array" } }, "required": [ "add", "delete" ], "type": "object", "x-akamai": { "file-path": "schemas/list-modify-items-content.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "detail": "The name :Site11 is not unique. Code-090415", "instance": "6702ffa9-3d06-4c5d-a099-1f7e2759bea2", "status": 409, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-409.yaml" } } } }, "description": "[Conflict with current state of resource](https://techdocs.akamai.com/etp-config/reference/409). Use the `X-etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/conflict-409.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Patch a list", "tags": [ "Lists" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } }, { "description": "A unique identifier for the list.", "in": "path", "name": "listId", "required": true, "schema": { "example": 3785, "type": "integer" }, "x-akamai": { "file-path": "parameters/list-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/items.yaml", "path-info": "/configs/{configId}/lists/{listId}/items" } }, "/configs/{configId}/log-export": { "post": { "description": "Creates a bulk log export destination configuration, which includes three default export schedules. Supports Linode and Azure storage destinations.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-log-export-destination" }, "operationId": "post-log-export-destination", "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": { "examples": { "ex-create-destination-azure": { "summary": "Azure", "value": { "$ref": "../examples/post-request-azure-export-destination-200.json" } }, "ex-create-destination-linode": { "summary": "Linode", "value": { "$ref": "../examples/post-request-linode-export-destination-200.json" } } }, "schema": { "additionalProperties": true, "description": "A bulk log export destination, which supports Azure and Linode storage.", "properties": { "parameters": { "oneOf": [ { "additionalProperties": false, "description": "An Azure bulk log export destination configuration.", "properties": { "accessKeySecret": { "description": "The access key secret.", "type": "string" }, "accountName": { "description": "The account name for the storage destination.", "type": "string" }, "destinationPath": { "description": "The storage bucket name.", "type": "string" }, "tenantId": { "description": "The storage tenant ID.", "type": "string" } }, "required": [ "accountName", "destinationPath", "tenantId", "accessKeySecret" ], "title": "Azure", "type": "object", "x-akamai": { "file-path": "schemas/post-request-azure-bulk-log-export-destination.yaml" } }, { "additionalProperties": false, "description": "Linode bulk log export destination properties.", "properties": { "accessKeyId": { "description": "The access key ID.", "type": "string" }, "accessKeySecret": { "description": "The access key secret.", "type": "string" }, "destinationPath": { "description": "The storage bucket name.", "type": "string" }, "encryptionToken": { "description": "The encryption token.", "type": "string" }, "url": { "description": "The bucket URL.", "type": "string" } }, "required": [ "encryptionToken", "accessKeyId", "destinationPath", "accessKeySecret", "url" ], "title": "Linode", "type": "object", "x-akamai": { "file-path": "schemas/post-request-linode-bulk-log-export-destination.yaml" } } ] }, "type": { "description": "The cloud storage destination type. Either `AzureBlob` or `LinodeS3`.", "enum": [ "AzureBlob", "LinodeS3" ], "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/post-request-bulk-log-export-destination.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "ex-create-azuree-destination-response": { "summary": "Azure", "value": { "$ref": "../examples/post-response-azure-export-destination-200.json" } }, "ex-create-linode-destination-response": { "summary": "Linode", "value": { "$ref": "../examples/post-response-linode-export-destination-200.json" } } }, "schema": { "additionalProperties": true, "description": "A bulk log export destination.", "properties": { "createdBy": { "description": "User who created the destination.", "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp when the destination was created.", "format": "date-time", "type": "string" }, "etpConfigId": { "description": "The ETP/SIA configuration ID.", "type": "integer" }, "id": { "description": "The log export schedule ID.", "type": "integer" }, "modifiedBy": { "description": "User who last modified the destination.", "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp when the change was made.", "format": "date-time", "type": "string" }, "parameters": { "oneOf": [ { "additionalProperties": false, "description": "An Azure export destination.", "properties": { "accessKeySecret": { "description": "The access key secret.", "type": "string" }, "accountName": { "description": "The account name for the storage destination.", "type": "string" }, "destinationPath": { "description": "The destination's storage bucket path.", "type": "string" }, "tenantId": { "description": "The storage tenant ID.", "type": "string" } }, "title": "Azure destination response", "type": "object", "x-akamai": { "file-path": "schemas/post-response-azure-bulk-log-export-destination-200.yaml" } }, { "additionalProperties": false, "description": "Linode export destination properties.", "properties": { "accessKeyId": { "description": "The access key ID.", "type": "string" }, "accessKeySecret": { "description": "The access key secret.", "type": "string" }, "destinationPath": { "description": "The storage bucket name.", "type": "string" }, "encryptionToken": { "description": "The encryption token.", "type": "string" }, "url": { "description": "The storage bucket URL.", "type": "string" } }, "title": "Linode destination response", "type": "object", "x-akamai": { "file-path": "schemas/post-response-linode-bulk-log-export-destination-200.yaml" } } ] }, "type": { "description": "The cloud storage destination type. Either `AzureBlob` or `LinodeS3`.", "enum": [ "AzureBlob", "LinodeS3" ], "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/post-response-bulk-log-export-destination-200.yaml" } } } }, "description": "Successfully created." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Create a bulk log export destination config", "tags": [ "Bulk log export" ] }, "get": { "description": "Retrieves the bulk log export destination configuration.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-log-export-destination" }, "operationId": "get-log-export-destination", "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": { "examples": { "ex-get-destination-azure-response": { "summary": "Azure", "value": { "$ref": "../examples/get-bulk-log-export-destination-azure-200.json" } }, "ex-get-destination-linode-response": { "summary": "Linode", "value": { "$ref": "../examples/get-bulk-log-export-destination-linode-200.json" } } }, "schema": { "additionalProperties": true, "description": "Configures a bulk log export destination.", "properties": { "createdBy": { "description": "Name of the user who created this export destination.", "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking the destination configuration's creation.", "format": "date-time", "type": "string" }, "deleted": { "default": false, "description": "Whether the destination configuration has been deleted.", "type": "boolean" }, "etpConfigId": { "description": "The ETP/SIA configuration ID.", "type": "integer" }, "id": { "description": "The log export schedule ID.", "type": "integer" }, "modifiedBy": { "description": "Name of the user who last modified this export destination.", "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking the destination configuration's last modification.", "format": "date-time", "type": "string" }, "parameters": { "oneOf": [ { "additionalProperties": false, "description": "A Linode bulk log export destination.", "properties": { "accessKeyId": { "description": "The access key ID.", "type": "string" }, "accessKeySecret": { "description": "The access key secret.", "type": "string" }, "destinationPath": { "description": "The storage bucket name.", "type": "string" }, "encryptionToken": { "description": "The encryption token.", "type": "string" }, "url": { "description": "The bucket URL.", "type": "string" } }, "title": "Linode destination get response", "type": "object", "x-akamai": { "file-path": "schemas/get-bulk-log-export-destination-linode-200.yaml" } }, { "additionalProperties": false, "description": "Configures a Linode bulk log export destination.", "properties": { "accessKeySecret": { "description": "The access key secret.", "type": "string" }, "accountName": { "description": "The account name for the storage destination.", "type": "string" }, "destinationPath": { "description": "The storage bucket name.", "type": "string" }, "tenantId": { "description": "The storage tenant ID.", "type": "string" } }, "title": "Azure destination get response", "type": "object", "x-akamai": { "file-path": "schemas/get-bulk-log-export-destination-azure-200.yaml" } } ] }, "type": { "description": "The cloud storage destination type. Either `AzureBlob` or `LinodeS3`.", "enum": [ "AzureBlob", "LinodeS3" ], "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-response-bulk-log-export-destination-200.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Get a bulk log export destination config", "tags": [ "Bulk log export" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/log-export.yaml", "path-info": "/configs/{configId}/log-export" } }, "/configs/{configId}/log-export/schedule": { "get": { "description": "Returns all bulk log export schedule configurations.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-log-export-schedules" }, "operationId": "get-log-export-schedules", "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": [ { "createdBy": "tyamada", "createdDate": "2024-04-26T14:06:31.942+00:00", "disabled": true, "etpConfigId": 1020454, "format": "csv", "logExportScheduleId": 123, "modifiedBy": "szhang", "modifiedDate": "2024-04-26T14:06:31.942+00:00", "reportType": "DNS_ACTIVITY", "runIntervalInMin": 10 }, { "createdBy": "jperez", "createdDate": "2024-04-26T14:06:32.468+00:00", "disabled": true, "etpConfigId": 1020454, "format": "csv", "logExportScheduleId": 124, "modifiedBy": "jsmith", "modifiedDate": "2024-04-26T14:06:32.468+00:00", "reportType": "PROXY_ACTIVITY", "runIntervalInMin": 10 }, { "createdBy": "alfulani", "createdDate": "2024-04-26T14:06:32.843+00:00", "disabled": true, "etpConfigId": 1020454, "format": "csv", "logExportScheduleId": 125, "modifiedBy": "szhang", "modifiedDate": "2024-04-26T14:06:32.843+00:00", "reportType": "EVENTS", "runIntervalInMin": 10 } ], "schema": { "items": { "additionalProperties": false, "properties": { "createdBy": { "description": "The user who created the schedule.", "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking the schedule's creation.", "format": "date-time", "type": "string" }, "disabled": { "default": true, "description": "Whether the schedule is disabled. Default is `true`.", "type": "boolean" }, "etpConfigId": { "description": "The ETP/SIA configuration ID.", "type": "integer" }, "format": { "default": "csv", "description": "The data format for the export.", "type": "string" }, "logExportScheduleId": { "description": "The export schedule's unique ID.", "type": "integer" }, "modifiedBy": { "description": "The user who last modified the schedule.", "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking the schedule's last modification.", "format": "date-time", "type": "string" }, "reportType": { "description": "The type of report exported on this schedule. Either `DNS_ACTIVITY`, `PROXY_ACTIVITY`, or `EVENTS`.", "enum": [ "DNS_ACTIVITY", "PROXY_ACTIVITY", "EVENTS" ], "type": "string" }, "runIntervalInMin": { "default": 10, "description": "__Read-only__ The number of minutes in the schedule run interval.", "readOnly": true, "type": "integer" } }, "type": "object" }, "type": "array", "x-akamai": { "file-path": "schemas/get-bulk-log-export-schedules-200.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "List bulk log export schedule configurations", "tags": [ "Bulk log export" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/schedule.yaml", "path-info": "/configs/{configId}/log-export/schedule" } }, "/configs/{configId}/log-export/schedule/{logExportScheduleId}/op/disable": { "post": { "description": "Disables a bulk log export schedule. Schedules are disabled by default.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-disable-log-export-schedule" }, "operationId": "post-disable-log-export-schedule", "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": { "202": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Disable a bulk log export schedule", "tags": [ "Bulk log export" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } }, { "description": "A unique identifier for the log export schedule.", "in": "path", "name": "logExportScheduleId", "required": true, "schema": { "example": 12, "type": "integer" }, "x-akamai": { "file-path": "parameters/log-export-schedule-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/disable.yaml", "path-info": "/configs/{configId}/log-export/schedule/{logExportScheduleId}/op/disable" } }, "/configs/{configId}/log-export/schedule/{logExportScheduleId}/op/enable": { "post": { "description": "Enables a bulk log export schedule. Schedules are disabled by default.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-enable-log-export-schedule" }, "operationId": "post-enable-log-export-schedule", "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": { "202": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Enable a bulk log export schedule", "tags": [ "Bulk log export" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } }, { "description": "A unique identifier for the log export schedule.", "in": "path", "name": "logExportScheduleId", "required": true, "schema": { "example": 12, "type": "integer" }, "x-akamai": { "file-path": "parameters/log-export-schedule-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/enable.yaml", "path-info": "/configs/{configId}/log-export/schedule/{logExportScheduleId}/op/enable" } }, "/configs/{configId}/log-export/{id}": { "post": { "description": "Updates the bulk log export destination configuration.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-update-log-export-destination" }, "operationId": "post-update-log-export-destination", "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": { "examples": { "ex-azure-update-request": { "summary": "Azure", "value": { "$ref": "../examples/post-request-azure-export-destination-200.json" } }, "ex-linode-update-request": { "summary": "Linode", "value": { "$ref": "../examples/post-request-linode-export-destination-200.json" } } }, "schema": { "additionalProperties": true, "description": "A bulk log export destination, which supports Azure and Linode storage.", "properties": { "parameters": { "oneOf": [ { "additionalProperties": false, "description": "An Azure bulk log export destination configuration.", "properties": { "accessKeySecret": { "description": "The access key secret.", "type": "string" }, "accountName": { "description": "The account name for the storage destination.", "type": "string" }, "destinationPath": { "description": "The storage bucket name.", "type": "string" }, "tenantId": { "description": "The storage tenant ID.", "type": "string" } }, "required": [ "accountName", "destinationPath", "tenantId", "accessKeySecret" ], "title": "Azure", "type": "object", "x-akamai": { "file-path": "schemas/post-request-azure-bulk-log-export-destination.yaml" } }, { "additionalProperties": false, "description": "Linode bulk log export destination properties.", "properties": { "accessKeyId": { "description": "The access key ID.", "type": "string" }, "accessKeySecret": { "description": "The access key secret.", "type": "string" }, "destinationPath": { "description": "The storage bucket name.", "type": "string" }, "encryptionToken": { "description": "The encryption token.", "type": "string" }, "url": { "description": "The bucket URL.", "type": "string" } }, "required": [ "encryptionToken", "accessKeyId", "destinationPath", "accessKeySecret", "url" ], "title": "Linode", "type": "object", "x-akamai": { "file-path": "schemas/post-request-linode-bulk-log-export-destination.yaml" } } ] }, "type": { "description": "The cloud storage destination type. Either `AzureBlob` or `LinodeS3`.", "enum": [ "AzureBlob", "LinodeS3" ], "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/post-request-bulk-log-export-destination.yaml" } } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "examples": { "ex-azure-response": { "summary": "Azure", "value": { "$ref": "../examples/post-response-azure-export-destination-200.json" } }, "ex-linode-response": { "summary": "Linode", "value": { "$ref": "../examples/post-response-linode-export-destination-200.json" } } }, "schema": { "additionalProperties": true, "description": "A bulk log export destination, which supports Azure and Linode storage.", "properties": { "parameters": { "oneOf": [ { "additionalProperties": false, "description": "An Azure bulk log export destination configuration.", "properties": { "accessKeySecret": { "description": "The access key secret.", "type": "string" }, "accountName": { "description": "The account name for the storage destination.", "type": "string" }, "destinationPath": { "description": "The storage bucket name.", "type": "string" }, "tenantId": { "description": "The storage tenant ID.", "type": "string" } }, "required": [ "accountName", "destinationPath", "tenantId", "accessKeySecret" ], "title": "Azure", "type": "object", "x-akamai": { "file-path": "schemas/post-request-azure-bulk-log-export-destination.yaml" } }, { "additionalProperties": false, "description": "Linode bulk log export destination properties.", "properties": { "accessKeyId": { "description": "The access key ID.", "type": "string" }, "accessKeySecret": { "description": "The access key secret.", "type": "string" }, "destinationPath": { "description": "The storage bucket name.", "type": "string" }, "encryptionToken": { "description": "The encryption token.", "type": "string" }, "url": { "description": "The bucket URL.", "type": "string" } }, "required": [ "encryptionToken", "accessKeyId", "destinationPath", "accessKeySecret", "url" ], "title": "Linode", "type": "object", "x-akamai": { "file-path": "schemas/post-request-linode-bulk-log-export-destination.yaml" } } ] }, "type": { "description": "The cloud storage destination type. Either `AzureBlob` or `LinodeS3`.", "enum": [ "AzureBlob", "LinodeS3" ], "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/post-request-bulk-log-export-destination.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Update a bulk log export destination config", "tags": [ "Bulk log export" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } }, { "description": "A unique identifier for the log export destination ID.", "in": "path", "name": "id", "required": true, "schema": { "example": 200, "type": "integer" }, "x-akamai": { "file-path": "parameters/destination-id-path.yaml" } }, { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } } ], "x-akamai": { "file-path": "paths/id.yaml", "path-info": "/configs/{configId}/log-export/{id}" } }, "/configs/{configId}/network-configuration": { "post": { "description": "Creates the network configuration.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-network-configuration" }, "operationId": "post-network-configuration", "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": { "corporateNetworkInternalIPsv4": [ "192.0.2.245", "192.0.2.46/24" ], "locations": [ { "IPsv4": [ "192.0.2.138" ], "IPsv6": [ "2019:D50::88/124" ], "locationId": "11111" } ] }, "schema": { "additionalProperties": false, "description": "Lists network configuration properties.", "properties": { "bypassURLs": { "description": "URLs that get bypassed from the network.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "corporateNetworkDNSSuffixes": { "description": "DNS domain suffixes for network.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "corporateNetworkInternalIPsv4": { "description": "IP addresses in IPv4 format for internal usage.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "corporateNetworkInternalIPsv6": { "description": "IP addresses in IPv6 format for internal usage.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "locations": { "description": "Locations in the network.", "items": { "additionalProperties": false, "properties": { "IPsv4": { "description": "IPv4 addresses.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "IPsv6": { "description": "IPv6 addresses.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "locationId": { "description": "__Read-only__ Unique identifier for the location.", "readOnly": true, "type": "string" } }, "required": [ "IPsv4", "IPsv6", "locationId" ], "type": "object" }, "minItems": 0, "type": "array" } }, "required": [ "corporateNetworkInternalIPsv4", "locations" ], "type": "object", "x-akamai": { "file-path": "schemas/network-configuration-create.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Create a network configuration", "tags": [ "Client network configurations" ] }, "get": { "description": "Provides network configuration details.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-network-configuration" }, "operationId": "get-network-configuration", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "bypassURLs": [ " https://linktobypassLocation" ], "corporateNetworkDNSSuffixes": [ "asdf.324.3444-3-3-3.com" ], "corporateNetworkInternalIPsv4": [ "192.0.2.250/24", "192.0.2.65/24" ], "corporateNetworkInternalIPsv6": [ "2019:D30::88/124", "2021:D32::88/124" ], "createdBy": "jsmith", "createdDate": "2018-08-20T18:11:36.911+0000", "locations": [ { "IPsv4": [ "192.0.2.140", "192.0.2.224" ], "IPsv6": [ "2019:D40::88/124", "2021:D42::88/124" ], "locationId": "2162" }, { "IPsv4": [ "192.0.2.225" ], "IPsv6": [ "2019:D50::88/124" ], "locationId": "5004" } ], "modifiedBy": "szhang@sia.com", "modifiedDate": "2020-08-06T23:30:59.861+0000", "networkConfigId": 624 }, "schema": { "additionalProperties": false, "description": "Lists the properties in the network configuration response object.", "properties": { "bypassURLs": { "description": "URLs that get bypassed from the network.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "corporateEmailDomains": { "description": "Corporate email domains.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "corporateNetworkDNSSuffixes": { "description": "DNS domain suffixes for each network.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "corporateNetworkInternalIPsv4": { "description": "IP addresses in IPv4 format for internal usage.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "corporateNetworkInternalIPsv6": { "description": "IP addresses in IPv6 format for internal usage.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "createdBy": { "description": "Name of the user who created this network config.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this network config's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "dnsHostsV4": { "description": "List IP address in IPv4 format of DNS Hosts.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "dnsHostsV6": { "description": "List IP address in IPv6 format of DNS Hosts.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "locations": { "description": "Locations in the network.", "items": { "additionalProperties": false, "properties": { "IPsv4": { "description": "IPv4 addresses.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "IPsv6": { "description": "IPv6 addresses.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "locationId": { "description": "Unique identifier for the location.", "minLength": 1, "type": "string" } }, "required": [ "IPsv4", "IPsv6", "locationId" ], "type": "object" }, "minItems": 0, "type": "array" }, "modifiedBy": { "description": "Name of the user who most recently modified the network config.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this network config's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "networkConfigId": { "description": "Unique identifier for this configuration.", "minimum": 1, "type": "integer" }, "wgExceptionIpsv4": { "description": "IP address exceptions in IPv4 format for walled garden.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "wgExceptionIpsv6": { "description": "IP address exceptions in IPv6 format for walled garden.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "wgExceptionSuffixes": { "description": "DNS suffixes for walled gardens.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "bypassURLs", "corporateNetworkDNSSuffixes", "corporateNetworkInternalIPsv4", "corporateNetworkInternalIPsv6", "createdBy", "createdDate", "locations", "networkConfigId" ], "type": "object", "x-akamai": { "file-path": "schemas/network-configuration-response.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get the network configuration", "tags": [ "Client network configurations" ] }, "put": { "description": "Modifies the network configuration.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-network-configuration" }, "operationId": "put-network-configuration", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "corporateNetworkInternalIPsv4": [ "192.0.2.190", "192.0.2.33/24" ], "locations": [ { "IPsv4": [ "192.0.2.2" ], "IPsv6": [ "2019:D50::88/124" ], "locationId": "11111" } ], "networkConfigId": 624 }, "schema": { "additionalProperties": false, "description": "Lists the network configuration update properties.", "properties": { "bypassURLs": { "description": "URLs that get bypassed from the network.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "corporateNetworkDNSSuffixes": { "description": "DNS domain suffixes for network.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "corporateNetworkInternalIPsv4": { "description": "IP addresses in IPv4 format for internal usage.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "corporateNetworkInternalIPsv6": { "description": "IP addresses in IPv6 format for internal usage.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "locations": { "description": "Locations in the network.", "items": { "additionalProperties": false, "properties": { "IPsv4": { "description": "IPv4 addresses.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "IPsv6": { "description": "IPv6 addresses.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "locationId": { "description": "__Read-only__ Unique identifier for the location.", "minLength": 1, "readOnly": true, "type": "string" } }, "required": [ "IPsv4", "IPsv6", "locationId" ], "type": "object" }, "minItems": 0, "type": "array" }, "networkConfigId": { "description": "__Read-only__ Unique identifier for this configuration.", "minimum": 1, "readOnly": true, "type": "integer" } }, "required": [ "corporateNetworkInternalIPsv4", "locations", "networkConfigId" ], "type": "object", "x-akamai": { "file-path": "schemas/network-configuration-update.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Update the network configuration", "tags": [ "Client network configurations" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/network-configuration.yaml", "path-info": "/configs/{configId}/network-configuration" } }, "/configs/{configId}/notifications-config": { "post": { "description": "Create notification configs in bulk.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-notifications-config" }, "operationId": "post-notifications-config", "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": [ { "attributes": [ { "category": "scheduledReport", "contentType": "text/html", "enabled": false }, { "category": "system", "contentType": "text/html", "enabled": true }, { "category": "upgrade", "contentType": "text/html", "enabled": true }, { "category": "alert", "contentType": "text/html", "enabled": true }, { "category": "vmUpgrade", "contentType": "text/html", "enabled": true } ], "id": 681, "siteMappings": [ { "siteId": 1234, "siteName": "SampleSite" } ], "siteSelectionStrategy": "ALL", "type": "email", "value": "adoad@akamai.com" } ], "schema": { "description": "Notification configurations.", "items": { "additionalProperties": false, "description": "Contains notification configuration details.", "properties": { "attributes": { "description": "Notification attributes.", "items": { "additionalProperties": false, "properties": { "category": { "description": "The notification category. Either `alert`, `upgrade`, `vmUpgrade`, `scheduledReport`, or `system`.", "enum": [ "alert", "upgrade", "vmUpgrade", "scheduledReport", "system" ], "type": "string" }, "contentType": { "description": "The notification's MIME type, either `text/html` or `text/plain`.", "enum": [ "text/html", "text/plain" ], "type": "string" }, "enabled": { "description": "Enables the notification.", "type": "boolean" } }, "required": [ "category", "contentType", "enabled" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ A unique identifier for notification config.", "minimum": 1, "readOnly": true, "type": "integer" }, "siteMappings": { "description": "Site details for the notification config.", "items": { "additionalProperties": false, "properties": { "siteId": { "description": "__Read-only__ The unique site ID for the notifications.", "minimum": 1, "readOnly": true, "type": "integer" }, "siteName": { "description": "The site name for the notifications.", "minLength": 1, "type": "string" } }, "required": [ "siteId", "siteName" ], "type": "object" }, "minItems": 0, "type": "array" }, "siteSelectionStrategy": { "description": "The location strategy adopted for notification, either `ALL` or `PARTIAL`.", "enum": [ "ALL", "PARTIAL" ], "type": "string" }, "type": { "description": "The mode of communication to subscriber.", "minLength": 1, "type": "string" }, "value": { "description": "The email of the subscriber.", "type": "string" } }, "required": [ "type", "value", "id", "siteSelectionStrategy", "siteMappings", "attributes" ], "type": "object", "x-akamai": { "file-path": "schemas/notification-config-update-specific.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/notification-config-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Create notifications configs", "tags": [ "Notifications" ] }, "get": { "description": "Provides all notification configurations.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-notifications-config" }, "operationId": "get-notifications-config", "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": [ { "attributes": [ { "category": "scheduledReport", "contentType": "text/html", "enabled": false }, { "category": "system", "contentType": "text/html", "enabled": false }, { "category": "upgrade", "contentType": "text/html", "enabled": false }, { "category": "vmUpgrade", "contentType": "text/html", "enabled": false }, { "category": "alert", "contentType": "text/html", "enabled": true } ], "createdBy": "jperez", "createdDate": "2017-08-22T19:39:17.408+0000", "id": 85, "modifiedBy": "tyamada", "modifiedDate": "2019-10-17T13:28:42.792+0000", "siteMappings": [ { "siteId": 1234, "siteName": "SampleSite" } ], "siteSelectionStrategy": "ALL", "type": "email", "value": "mchantor@akamai.com" }, { "attributes": [ { "category": "scheduledReport", "contentType": "text/html", "enabled": false }, { "category": "system", "contentType": "text/html", "enabled": false }, { "category": "upgrade", "contentType": "text/html", "enabled": false }, { "category": "vmUpgrade", "contentType": "text/html", "enabled": false }, { "category": "alert", "contentType": "text/html", "enabled": true } ], "createdBy": "adevi", "createdDate": "2017-08-09T19:28:06.966+0000", "id": 120, "modifiedBy": "jsmith", "modifiedDate": "2019-10-17T13:28:42.801+0000", "siteMappings": [ { "siteId": 1234, "siteName": "SampleSite" } ], "siteSelectionStrategy": "ALL", "type": "email", "value": "jyeung@akamai.com" }, { "attributes": [ { "category": "vmUpgrade", "contentType": "text/html", "enabled": true }, { "category": "scheduledReport", "contentType": "text/html", "enabled": false }, { "category": "system", "contentType": "text/html", "enabled": true }, { "category": "upgrade", "contentType": "text/html", "enabled": true }, { "category": "alert", "contentType": "text/html", "enabled": true } ], "createdBy": "tyamada", "createdDate": "2017-11-22T06:33:54.572+0000", "id": 941, "modifiedBy": "tyamada", "modifiedDate": "2019-10-17T13:28:42.842+0000", "siteMappings": [ { "siteId": 1234, "siteName": "SampleSite" } ], "siteSelectionStrategy": "ALL", "type": "email", "value": "rannadan@akamai.com" } ], "schema": { "description": "Notification configuration.", "items": { "additionalProperties": false, "description": "Specifies notification configuration details.", "properties": { "attributes": { "description": "Notification attributes.", "items": { "additionalProperties": false, "properties": { "category": { "description": "The category of notification. Either `alert`, `upgrade`, `vmUpgrade`, `scheduledReport`, `email`, or `system`.", "enum": [ "alert", "upgrade", "vmUpgrade", "scheduledReport", "system", "email" ], "minLength": 1, "type": "string" }, "contentType": { "description": "The notification's MIME type, either `text/html` or `text/plain`.", "enum": [ "text/html", "text/plain" ], "minLength": 1, "type": "string" }, "enabled": { "description": "Enables the notification.", "type": "boolean" } }, "required": [ "category", "contentType", "enabled" ], "type": "object" }, "minItems": 0, "type": "array" }, "createdBy": { "description": "Name of the user who created this notification config.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this notification config's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "id": { "description": "A unique identifier for notification config.", "minimum": 1, "type": "integer" }, "modifiedBy": { "description": "Name of the user who most recently modified this notification config.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this notification config's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "siteMappings": { "description": "Site mappings for the notification config.", "items": { "additionalProperties": false, "properties": { "siteId": { "description": "Unique identifier of site for the notifications.", "minimum": 1, "type": "integer" }, "siteName": { "description": "Name of site for the notifications.", "minLength": 1, "type": "string" } }, "required": [ "siteId", "siteName" ], "type": "object" }, "minItems": 0, "type": "array" }, "siteSelectionStrategy": { "description": "The location strategy adopted for notification, either `ALL` or `PARTIAL`.", "enum": [ "ALL", "PARTIAL" ], "type": "string" }, "type": { "description": "The subscriber notification method. Either `alert`, `upgrade`, `vmUpgrade`, `scheduledReport`, `email`, or `system`.", "enum": [ "alert", "upgrade", "vmUpgrade", "scheduledReport", "system", "email" ], "type": "string" }, "value": { "description": "The email of the subscriber.", "type": "string" } }, "required": [ "type", "value", "id", "createdBy", "createdDate", "siteSelectionStrategy", "siteMappings", "attributes" ], "type": "object", "x-akamai": { "file-path": "schemas/notification-config.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/notification-config-all.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List notification configurations", "tags": [ "Notifications" ] }, "put": { "description": "Updates the notification configs in bulk.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-notifications-config" }, "operationId": "put-notifications-config", "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": [ { "attributes": [ { "category": "scheduledReport", "contentType": "text/html", "enabled": false }, { "category": "system", "contentType": "text/html", "enabled": true }, { "category": "upgrade", "contentType": "text/html", "enabled": true }, { "category": "alert", "contentType": "text/html", "enabled": true }, { "category": "vmUpgrade", "contentType": "text/html", "enabled": true } ], "id": 681, "siteMappings": [ { "siteId": 1234, "siteName": "SampleSite" } ], "siteSelectionStrategy": "ALL", "type": "email", "value": "adoad@akamai.com" } ], "schema": { "description": "Notification configurations.", "items": { "additionalProperties": false, "description": "Contains notification configuration details.", "properties": { "attributes": { "description": "Notification attributes.", "items": { "additionalProperties": false, "properties": { "category": { "description": "The notification category. Either `alert`, `upgrade`, `vmUpgrade`, `scheduledReport`, or `system`.", "enum": [ "alert", "upgrade", "vmUpgrade", "scheduledReport", "system" ], "type": "string" }, "contentType": { "description": "The notification's MIME type, either `text/html` or `text/plain`.", "enum": [ "text/html", "text/plain" ], "type": "string" }, "enabled": { "description": "Enables the notification.", "type": "boolean" } }, "required": [ "category", "contentType", "enabled" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ A unique identifier for notification config.", "minimum": 1, "readOnly": true, "type": "integer" }, "siteMappings": { "description": "Site details for the notification config.", "items": { "additionalProperties": false, "properties": { "siteId": { "description": "__Read-only__ The unique site ID for the notifications.", "minimum": 1, "readOnly": true, "type": "integer" }, "siteName": { "description": "The site name for the notifications.", "minLength": 1, "type": "string" } }, "required": [ "siteId", "siteName" ], "type": "object" }, "minItems": 0, "type": "array" }, "siteSelectionStrategy": { "description": "The location strategy adopted for notification, either `ALL` or `PARTIAL`.", "enum": [ "ALL", "PARTIAL" ], "type": "string" }, "type": { "description": "The mode of communication to subscriber.", "minLength": 1, "type": "string" }, "value": { "description": "The email of the subscriber.", "type": "string" } }, "required": [ "type", "value", "id", "siteSelectionStrategy", "siteMappings", "attributes" ], "type": "object", "x-akamai": { "file-path": "schemas/notification-config-update-specific.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/notification-config-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Update notification configurations", "tags": [ "Notifications" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/notifications-config.yaml", "path-info": "/configs/{configId}/notifications-config" } }, "/configs/{configId}/notifications-config/{notificationType}": { "get": { "description": "Gets notification details for the given notification type.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-config-notification-type" }, "operationId": "get-config-notification-type", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "emails": { "allLoc": [ "aa@akamai.com", "bb@akamai.com", "cc@akamai.com", "dd@akamai.com", "ff@nomail-akamai.com", "gg@akamai.com", "hh@akamai.com", "jj@akamai.com", "kk@akamai.com", "tt@akamai.com" ], "itemCount": 11, "remainingCount": 489 }, "totalItemCount": 11, "totalRemainingCount": 989 }, "schema": { "additionalProperties": false, "description": "Represents a notification configuration for the given type.", "properties": { "emails": { "additionalProperties": false, "description": "Details of subscribers who have subscribed for emails on this notification type.", "properties": { "allLoc": { "description": "Emails for all locations generating the notification.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "itemCount": { "description": "The number of email subscribers to the notification type.", "minimum": 0, "type": "integer" }, "remainingCount": { "description": "The number of email subscribers pending the subscription for the notification type.", "minimum": 0, "type": "integer" } }, "required": [ "allLoc" ], "type": "object" }, "totalItemCount": { "description": "The number of subscribers to the notification type.", "minimum": 0, "type": "integer" }, "totalRemainingCount": { "description": "The number of subscribers pending the subscription for the notification type.", "minimum": 0, "type": "integer" } }, "required": [ "emails" ], "type": "object", "x-akamai": { "file-path": "schemas/notification-config-type.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get notification configuration for type", "tags": [ "Notifications" ] }, "put": { "description": "Updates the subscribers to the given notification type.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-config-notification-type" }, "operationId": "put-config-notification-type", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "emails": { "allLoc": [ "newEmail@akamai.com" ] } }, "schema": { "additionalProperties": false, "description": "Represents a notification configuration for the given type.", "properties": { "emails": { "additionalProperties": false, "description": "Details of subscribers who have subscribed for emails on this notification type.", "properties": { "allLoc": { "description": "Emails for all locations generating the notification.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "allLoc" ], "type": "object" } }, "required": [ "emails" ], "type": "object", "x-akamai": { "file-path": "schemas/notification-config-type-update.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Update the subscribers to notification type", "tags": [ "Notifications" ] }, "parameters": [ { "description": "__Enum__ Notification type used to query for configurations.", "in": "path", "name": "notificationType", "required": true, "schema": { "enum": [ "alert", "upgrade", "vmUpgrade", "scheduledReport", "system" ], "example": "alert", "type": "string" }, "x-akamai": { "file-path": "parameters/notification-type-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/notification-type.yaml", "path-info": "/configs/{configId}/notifications-config/{notificationType}" } }, "/configs/{configId}/onboard-tenant": { "post": { "description": "Onboards a new Tenant.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-onboard-tenant" }, "operationId": "post-onboard-tenant", "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": { "name": "enterprisestaging31", "users": [ { "id": 225, "uiIdentityId": "F-XX-3840197", "uiUserName": "user@sia.com" } ] }, "schema": { "additionalProperties": false, "description": "Tenant onboard request details.", "properties": { "groupIds": { "description": "The group IDs with access to the tenant.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "hideSetupWizard": { "description": "Hides the setup wizard.", "type": "boolean" }, "inheritClientConfig": { "description": "Whether to inherit the client configuration from the parent.", "type": "boolean" }, "inheritErrorPage": { "description": "Whether to inherit the error page from the parent.", "type": "boolean" }, "inheritNetworkConfig": { "description": "Whether to inherit the network configuration from the parent.", "type": "boolean" }, "name": { "description": "Unique name for the tenant.", "minLength": 1, "type": "string" }, "policyTemplateId": { "description": "The policy template used for the tenant.", "minimum": 1, "type": "integer" }, "users": { "description": "The assigned tenant users.", "items": { "additionalProperties": false, "description": "Tenant user details.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the user.", "minimum": 1, "readOnly": true, "type": "integer" }, "isViewer": { "description": "Whether the user has only the viewer role.", "type": "boolean" }, "uiIdentityId": { "description": "The user identifier.", "minLength": 1, "type": "string" }, "uiUserName": { "description": "The username of the tenant user.", "minLength": 1, "type": "string" } }, "required": [ "id", "uiIdentityId", "uiUserName" ], "type": "object", "x-akamai": { "file-path": "schemas/tenant-user.yaml" } }, "minItems": 1, "type": "array" }, "viewerUsers": { "description": "The tenant viewer users.", "items": { "additionalProperties": false, "description": "Tenant user details.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the user.", "minimum": 1, "readOnly": true, "type": "integer" }, "isViewer": { "description": "Whether the user has only the viewer role.", "type": "boolean" }, "uiIdentityId": { "description": "The user identifier.", "minLength": 1, "type": "string" }, "uiUserName": { "description": "The username of the tenant user.", "minLength": 1, "type": "string" } }, "required": [ "id", "uiIdentityId", "uiUserName" ], "type": "object", "x-akamai": { "file-path": "schemas/tenant-user.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "name", "users" ], "type": "object", "x-akamai": { "file-path": "schemas/tenant-onboard-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response.", "headers": { "configId": { "description": "Header value with the newly created configuration ID.", "schema": { "example": "123456", "type": "string" }, "x-akamai": { "file-path": "headers/response-config-id.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "406": { "content": { "application/problem+json": { "example": { "detail": "Contract already onboarded. Code-090209", "instance": "3eea5330-087f-4e1c-8db5-029fd8e4cd01", "status": 406, "title": "Not acceptable", "type": "https://problems.omni.akamaiapis.net/http/not-acceptable" }, "schema": { "additionalProperties": true, "description": "Onboard response for an onboarded contract.", "properties": { "detail": { "description": "The error message in detail.", "minLength": 1, "type": "string" }, "instance": { "description": "Instance ID where the error occurred.", "minLength": 1, "type": "string" }, "status": { "description": "HTTP status code.", "minimum": 0, "type": "integer" }, "type": { "description": "The SIA error type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/onboard-response.yaml" } } } }, "description": "[Resource already onboarded](https://techdocs.akamai.com/etp-config/reference/406).", "x-akamai": { "file-path": "errors/already-onboarded-406.yaml" } } }, "summary": "Onboard a tenant", "tags": [ "Tenants" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/onboard-tenant.yaml", "path-info": "/configs/{configId}/onboard-tenant" } }, "/configs/{configId}/patterns": { "post": { "description": "Creates a DLP custom dictionary pattern.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-patterns" }, "operationId": "post-patterns", "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": { "description": "PII-detecting pattern", "name": "PII", "regexIds": [ "6040", "6125", "6200" ], "regexes": [ { "id": "6040", "regex": "123" }, { "id": "6125", "regex": "1,2" }, { "id": "6200", "regex": "1123" }, { "regex": "domain.com" } ] }, "schema": { "additionalProperties": false, "description": "Creates a data loss protection (DLP) pattern.", "properties": { "akamaiDefined": { "description": "Indicates an Akamai-defined pattern.", "type": "boolean" }, "description": { "description": "A description of the DLP pattern.", "type": "string" }, "name": { "description": "Name of the DLP pattern.", "type": "string" }, "regexIds": { "description": "Unique identifier for the DLP pattern.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "regexes": { "description": "Applicable regular expressions.", "items": { "additionalProperties": false, "properties": { "id": { "description": "Unique ID for the regex pattern.", "type": "string" }, "regex": { "description": "Contents of the regular expression entry.", "minLength": 1, "type": "string" } }, "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "name", "regexes" ], "type": "object", "x-akamai": { "file-path": "schemas/dlp-pattern-create.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Create a DLP pattern", "tags": [ "DLP dictionary patterns" ] }, "get": { "description": "Returns the DLP dictionary patterns.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-patterns" }, "operationId": "get-patterns", "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": [ { "description": "Specified quantity of both credit or debit card numbers and of associated phrases such as:-\n* \"csv\"\n* \"Expiry Date\"\n* \"Bankleitzahl\"\n* \"American Express\"\n* \"handelsbanken\"\n\nFor a definition of credit card numbers that are detected please see the CCL description for \"Credit card numbers [Universal]\".", "id": 13, "name": "Credit card numbers - with phrases [Universal]" }, { "description": "Credit, debit, travel, store or membership card numbers using a common bank identification numbering system. Such as:-\n* 16 digit card numbers (including MasterCard and VISA)\n* American Express\n* CUP (China Union Pay)\n* Diners Club\n* Ita\u00fa Unibanco\n* JCB\n* Maestro\n* Royal Bank of Canada\n* ScotiBank\n* Verve\n* magnetic track data containing card numbers\n\nCard numbers must conform to the following:-\n* Start with a \"3\", \"4\", \"5\" or \"6\" i.e. be a standard format ISO/IEC 7812 number with a Major Industry Identifier (MII) for 'Travel and entertainment', 'Banking and financial' or 'Merchandising and banking/financial'.\n* If not 16 digits then start with a recognised Issuer Identification Number (IIN)\n* Have an appropriate length for the card issuer\n* Either be contiguous or have an appropriate digit grouping for the issuer\n* Any digit groupings to be separated by a white space \" \", dash \"-\" or dash variant\n* Have a valid Luhn check digit\n* Must not appear to be part of a larger digit sequence\n\nNOTE: Card numbers used for other non-financial purposes but that use the same format as monetary cards will be detected as credit cards. This is because:- \n* These cards typically have high PII risk\n* Loyalty cards (etc.) often do have an actual financial value or financial consequence\n* Card issuers have been known to upgrade loyalty & travel cards to have a financial value", "id": 14, "name": "Credit card numbers [Universal]" }, { "description": "Card magnetic track 2 data according to the ISO/IEC 7813 specification.\n\nThis detection is included within the CCL \"Credit card numbers [Global]\". \nThis CCL is provided as an optional level of granularity.", "id": 128, "name": "Credit card magnetic track 2 [Universal]" }, { "description": "Card magnetic track 1 data according to the ISO/IEC 7813 specification.\n\nThis detection is included in the CCL \"Credit card numbers [Global]\". \nThis CCL is provided as an optional level of granularity.", "id": 127, "name": "Credit card magnetic track 1 [Universal]" } ], "schema": { "description": "All data loss protection (DLP) dictionaries for a configuration.", "items": { "additionalProperties": false, "description": "Lists DLP pattern detail properties.", "properties": { "description": { "description": "A description of the DLP pattern.", "minLength": 1, "type": "string" }, "id": { "description": "A unique identifier for the data loss protection (DLP) pattern.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the DLP pattern.", "minLength": 1, "type": "string" } }, "required": [ "name", "description", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/dlp-pattern-details.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/dlp-patterns-list.yaml" } } } }, "description": "DLP patterns with details." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List DLP dictionary patterns", "tags": [ "DLP dictionary patterns" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/patterns.yaml", "path-info": "/configs/{configId}/patterns" } }, "/configs/{configId}/patterns/regexes": { "post": { "description": "Creates DLP regular expressions.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-dlp-regexes" }, "operationId": "post-dlp-regexes", "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": [ { "regex": "example.com" }, { "regex": "*.com" } ], "schema": { "description": "Regular expression entries to add to a data loss protection (DLP) dictionary.", "items": { "additionalProperties": false, "properties": { "regex": { "description": "Contents of the regular expression entry.", "minLength": 1, "type": "string" } }, "type": "object" }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/regex-create.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Create DLP regular expressions", "tags": [ "DLP regexes" ] }, "get": { "description": "Returns all DLP regular expressions.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-dlp-regexes" }, "operationId": "get-dlp-regexes", "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": [ { "createdBy": "jsmith", "createdDate": "2022-02-07T11:11:54.053+00:00", "id": "6180", "modifiedBy": "jsmith", "modifiedDate": "2022-02-07T11:11:54.053+00:00", "regex": "*.com" }, { "createdBy": "jsmith", "createdDate": "2022-02-01T07:37:35.697+00:00", "id": "6140", "modifiedBy": "jsmith", "modifiedDate": "2022-02-01T07:37:35.697+00:00", "regex": "example.com" }, { "createdBy": "jkowalski", "createdDate": "2022-02-02T10:23:55.734+00:00", "id": "6160", "modifiedBy": "jsmith", "modifiedDate": "2022-02-02T10:23:55.734+00:00", "regex": "2" } ], "schema": { "description": "Contains a data loss protection (DLP) dictionary regular expression entry.", "items": { "additionalProperties": false, "description": "Contains data loss protection (DLP) dictionary regular expression entry details.", "properties": { "createdBy": { "description": "Name of the user who created the regular expression entry.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the regular expression entry's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "id": { "description": "__Read-only__ Unique identifier for the regular expression entry.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedBy": { "description": "__Read-only__ Name of the user to last modify the regex entry.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the regular expression entry's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "regex": { "description": "Contents of the regular expression entry.", "minLength": 1, "type": "string" } }, "required": [ "id", "regex" ], "type": "object", "x-akamai": { "file-path": "schemas/regex-specific.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/regex-retrieve-all.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List DLP regular expressions", "tags": [ "DLP regexes" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/regexes.yaml", "path-info": "/configs/{configId}/patterns/regexes" } }, "/configs/{configId}/patterns/regexes/{regexId}": { "get": { "description": "Returns the specified DLP regular expression details.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-dlp-regex" }, "operationId": "get-dlp-regex", "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": { "createdBy": "jsmith", "createdDate": "2022-02-07T11:11:54.053+00:00", "id": "6000", "modifiedBy": "jsmith", "modifiedDate": "2022-02-07T11:11:54.053+00:00", "regex": "example.com" }, "schema": { "additionalProperties": false, "description": "Contains data loss protection (DLP) dictionary regular expression entry details.", "properties": { "createdBy": { "description": "Name of the user who created the regular expression entry.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the regular expression entry's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "id": { "description": "__Read-only__ Unique identifier for the regular expression entry.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedBy": { "description": "__Read-only__ Name of the user to last modify the regex entry.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the regular expression entry's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "regex": { "description": "Contents of the regular expression entry.", "minLength": 1, "type": "string" } }, "required": [ "id", "regex" ], "type": "object", "x-akamai": { "file-path": "schemas/regex-specific.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get a DLP regular expression", "tags": [ "DLP regexes" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } }, { "description": "Unique identifier for each DLP regular expression entry.", "in": "path", "name": "regexId", "required": true, "schema": { "example": 6000, "type": "integer" }, "x-akamai": { "file-path": "parameters/regex-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/regex.yaml", "path-info": "/configs/{configId}/patterns/regexes/{regexId}" } }, "/configs/{configId}/patterns/{patternId}": { "get": { "description": "Returns the specified DLP dictionary pattern.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-pattern" }, "operationId": "get-pattern", "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": { "akamaiDefined": false, "createdBy": "jsmith", "createdDate": "2022-02-07T15:00:14.386+00:00", "id": "100263", "modifiedBy": "jsmith", "modifiedDate": "2022-02-10T16:15:38.533+00:00", "name": "LGCustomPatterns", "regexIds": [ "6000" ], "regexes": [ { "createdBy": "jsmith", "createdDate": "2021-12-28T11:15:43.068+00:00", "id": "6000", "modifiedBy": "jsmith", "modifiedDate": "2021-12-28T11:15:43.068+00:00", "regex": "domain.com" } ] }, "schema": { "additionalProperties": false, "description": "DLP patterns.", "properties": { "akamaiDefined": { "description": "Whether the DLP pattern is Akamai-defined. If `true`, you can't delete the pattern.", "type": "boolean" }, "createdBy": { "description": "Name of the user who created this DLP pattern.", "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp of this DLP pattern's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier for the DLP pattern.", "type": "string" }, "modifiedBy": { "description": "Name of the user who last modified the DLP pattern.", "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this DLP pattern's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the DLP pattern.", "type": "string" }, "regexIds": { "description": "Unique identifier for the DLP pattern.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "regexes": { "description": "Configured DLP regular expressions to match traffic.", "items": { "additionalProperties": false, "description": "Contains data loss protection (DLP) dictionary regular expression entry details.", "properties": { "createdBy": { "description": "Name of the user who created the regular expression entry.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the regular expression entry's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "id": { "description": "__Read-only__ Unique identifier for the regular expression entry.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedBy": { "description": "__Read-only__ Name of the user to last modify the regex entry.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the regular expression entry's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "regex": { "description": "Contents of the regular expression entry.", "minLength": 1, "type": "string" } }, "required": [ "id", "regex" ], "type": "object", "x-akamai": { "file-path": "schemas/regex-specific.yaml" } }, "minItems": 1, "type": "array" } }, "required": [ "id", "name", "regexes" ], "type": "object", "x-akamai": { "file-path": "schemas/dlp-pattern-get.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get a DLP dictionary pattern", "tags": [ "DLP dictionary patterns" ] }, "delete": { "description": "Removes the specified DLP dictionary pattern.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/delete-pattern" }, "operationId": "delete-pattern", "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": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Delete a DLP dictionary pattern", "tags": [ "DLP dictionary patterns" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } }, { "description": "Unique identifier for each DLP pattern entry.", "in": "path", "name": "patternId", "required": true, "schema": { "example": 100263, "type": "integer" }, "x-akamai": { "file-path": "parameters/pattern-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/pattern.yaml", "path-info": "/configs/{configId}/patterns/{patternId}" } }, "/configs/{configId}/policies": { "post": { "description": "Creates a new policy.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-policy" }, "operationId": "post-policy", "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": { "aupSettings": [ { "categoryId": 2, "responseId": 2 } ], "basicSettings": { "dnssec": false, "edns0ecs": false }, "description": "EMEA sites", "name": "EMEA policy", "securitySettings": [ { "confirmedResponseId": 1, "listId": 1, "shouldNotifyConfirmed": true, "shouldNotifySuspected": true, "suspectedResponseId": 1 } ], "sites": [ 100 ] }, "schema": { "additionalProperties": false, "description": "The security policy to assign to a site. You can configure the accepted use policy (AUP) and set responses for known and suspected threats under specified categories.", "properties": { "aupSettings": { "description": "Contains the acceptable use policy settings.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" } }, "required": [ "categoryId", "responseId" ], "type": "object" }, "minItems": 0, "type": "array" }, "basicSettings": { "additionalProperties": false, "description": "Specifies the basic policy settings.", "properties": { "dnssec": { "description": "Enables DNS security.", "type": "boolean" }, "edns0ecs": { "description": "When enabled, optimizes CDN traffic using the EDNS-Client-Subnet extension.", "type": "boolean" } }, "required": [ "dnssec", "edns0ecs" ], "type": "object" }, "description": { "description": "A description of the policy that you provide.", "minLength": 1, "type": "string" }, "name": { "description": "The name of the policy.", "minLength": 1, "type": "string" }, "securitySettings": { "description": "Lists the policy security settings.", "items": { "additionalProperties": false, "properties": { "confirmedResponseId": { "description": "__Read-only__ A unique identifier for the confirmed response.", "minimum": 1, "readOnly": true, "type": "integer" }, "listId": { "description": "__Read-only__ A unique identifier for the list.", "minimum": 1, "readOnly": true, "type": "integer" }, "shouldNotifyConfirmed": { "description": "Send alert on confirmed threat.", "type": "boolean" }, "shouldNotifySuspected": { "description": "Send alert on suspected threat.", "type": "boolean" }, "suspectedResponseId": { "description": "__Read-only__ A unique identifier for the suspected response.", "minimum": 1, "readOnly": true, "type": "integer" } }, "required": [ "confirmedResponseId", "listId", "shouldNotifyConfirmed", "shouldNotifySuspected", "suspectedResponseId" ], "type": "object" }, "minItems": 0, "type": "array" }, "sites": { "description": "Lists associated site IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" } }, "required": [ "description", "name", "aupSettings", "securitySettings", "basicSettings", "sites" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-create.yaml" } } } }, "required": true }, "responses": { "201": { "content": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Create a policy", "tags": [ "Policies" ] }, "get": { "description": "Returns all policies.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-policies" }, "operationId": "get-policies", "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": [ { "accessConfig": { "configurable": true, "delegatedAdmins": [ "delegatedAdmin@org.com" ], "readable": true }, "akamaiDefined": true, "aupSettings": [ { "categoryId": 1, "categoryInfo": { "code": "AKA-SOCIAL", "defaultActionId": 5, "deprecated": false, "id": 1, "name": "Social" }, "groups": [ "groupName1" ], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [ { "id": 4, "name": "Block" } ], "users": [ "jsmith@org.com" ] } ], "authenticationMode": "NONE", "basicSettings": { "dnssec": false, "edns0ecs": true, "forwardProxyEnabled": false, "proxyEnabled": false, "safesearch": false, "trustXFF": false }, "createdBy": "adevi", "createdDate": "2017-04-25T22:26:15.597+0000", "description": "Default policy", "id": 2480, "ipaSettings": { "enabled": false, "randomCheck": false, "zdp": false }, "modifiedBy": "jperez", "modifiedDate": "2020-06-25T20:20:33.114+0000", "name": "Default", "policyGeneralSettings": { "aupMigrated": true }, "riskyFileHandlingSettings": { "hugeRiskyFileResponse": { "id": 5, "name": "Allow" }, "largeRiskyFileResponse": { "id": 5, "name": "Allow" } }, "safeSearchSettings": { "youtube": "open" }, "securitySettings": [ { "confirmedResponseId": 760, "confirmedResponseInfo": { "id": 760, "name": "Sinkhole 1" }, "listId": 1, "listInfo": { "categoryId": 1, "id": 1, "name": "Malware" }, "shouldNotifyConfirmed": true, "shouldNotifySuspected": true, "suspectedResponseId": 760, "suspectedResponseInfo": { "id": 760, "name": "Sinkhole 1" } }, { "confirmedResponseId": 760, "confirmedResponseInfo": { "id": 760, "name": "Sinkhole 1" }, "listId": 3, "listInfo": { "categoryId": 3, "id": 3, "name": "C&C" }, "shouldNotifyConfirmed": true, "shouldNotifySuspected": true, "suspectedResponseId": 760, "suspectedResponseInfo": { "id": 760, "name": "Sinkhole 1" } }, { "confirmedResponseId": 2, "confirmedResponseInfo": { "id": 2, "name": "Block - DNS" }, "listId": 4, "listInfo": { "categoryId": 5, "id": 4, "name": "DNS Exfiltration" }, "shouldNotifyConfirmed": true, "shouldNotifySuspected": true, "suspectedResponseId": 2, "suspectedResponseInfo": { "id": 2, "name": "Block - DNS" } }, { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 3785, "listInfo": { "categoryId": 1, "id": 3785, "name": "Costa Rica WB" }, "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 1, "suspectedResponseInfo": { "id": 1, "name": "Monitor" } }, { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 4541, "listInfo": { "categoryId": 4, "id": 4541, "name": "Mchantor_LNS_List" }, "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 1, "suspectedResponseInfo": { "id": 1, "name": "Monitor" } }, { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 3905, "listInfo": { "categoryId": 4, "id": 3905, "name": "Kartik" }, "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 1, "suspectedResponseInfo": { "id": 1, "name": "Monitor" } }, { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 4021, "listInfo": { "categoryId": 4, "id": 4021, "name": "CR Akatec List" }, "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 1, "suspectedResponseInfo": { "id": 1, "name": "Monitor" } }, { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 5562, "listInfo": { "categoryId": 1, "id": 5562, "name": "anon" }, "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 1, "suspectedResponseInfo": { "id": 1, "name": "Monitor" } }, { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 5821, "listInfo": { "categoryId": 4, "id": 5821, "name": "BGLR" }, "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 1, "suspectedResponseInfo": { "id": 1, "name": "Monitor" } }, { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 5823, "listInfo": { "categoryId": 2, "id": 5823, "name": "Mel_" }, "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 1, "suspectedResponseInfo": { "id": 1, "name": "Monitor" } }, { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 5762, "listInfo": { "categoryId": 1, "id": 5762, "name": "ishamy_customlist" }, "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 1, "suspectedResponseInfo": { "id": 1, "name": "Monitor" } }, { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 6942, "listInfo": { "categoryId": 1, "id": 6942, "name": "priya_" }, "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 760, "suspectedResponseInfo": { "id": 760, "name": "Sinkhole 1" } }, { "confirmedResponseId": 10, "confirmedResponseInfo": { "id": 10, "name": "Bypass" }, "listId": 32336, "listInfo": { "categoryId": 4, "id": 32336, "name": "Allow List - migrated Quick List" }, "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 10, "suspectedResponseInfo": { "id": 10, "name": "Bypass" } }, { "confirmedResponseId": 4, "confirmedResponseInfo": { "id": 4, "name": "Block - Error Page" }, "listId": 32337, "listInfo": { "categoryId": 4, "id": 32337, "name": "Deny List - migrated Quick List" }, "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 4, "suspectedResponseInfo": { "id": 4, "name": "Block - Error Page" } } ], "sites": [ 2160, 18217, 991731, 991733 ], "sitesInfo": [ { "id": 2160, "name": "Unidentified IPs" }, { "id": 18217, "name": "DDNS" }, { "id": 991731, "name": "aasdfsadfdsa" }, { "id": 991733, "name": "11adakjsdhfkjaslhdfkjlashldfkljashdfjashdfasdfasdfsakjhasjkdfhkaljshdfkljhasfadfasfdasdfasdfsadf" } ] } ], "schema": { "description": "The security policy to assign to a site. You can configure the accepted use policy and set responses for known and suspected threats under specified categories.", "items": { "additionalProperties": false, "description": "The security policy to assign to a site. Configure the accepted use policy and set responses for known and suspected threats under the specified categories.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Marks a policy as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated administrators for the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks a policy as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "akamaiDefined": { "description": "Marks a policy as Akamai-defined.", "type": "boolean" }, "aupSettings": { "description": "Contains the acceptable use policy settings.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AUP category data.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "groups": { "description": "Groups users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Describes the operation settings on the AUP setting.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Lists user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "categoryId" ], "type": "object" }, "minItems": 0, "type": "array" }, "aupSource": { "description": "Name of acceptable use policy source for the policy.", "minLength": 1, "type": "string" }, "authPolicy": { "additionalProperties": false, "description": "Details of the authorization policy adopted for the policy.", "properties": { "Oidc": { "additionalProperties": false, "description": "Provides OpenID Connect (OIDC) provider and client details.", "properties": { "client": { "additionalProperties": false, "description": "Provides information about a client.", "properties": { "authUri": { "description": "URL for authorization.", "type": "string" }, "checkSessionUri": { "description": "URL to check if session is alive.", "type": "string" }, "clientId": { "description": "__Read-only__ A unique identifier for the client.", "minimum": 1, "readOnly": true, "type": "integer" }, "clientName": { "description": "Name of the client.", "minLength": 1, "type": "string" }, "endSessionUri": { "description": "URL for ending session.", "type": "string" }, "frontChannelLogoutUrl": { "description": "URLs for logout from front channel.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "grantTypes": { "description": "Client grant types.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "idpId": { "description": "__Read-only__ A unique identifier for the IDP for the OIDC.", "minLength": 1, "readOnly": true, "type": "string" }, "javascriptOrigins": { "description": "JavaScript origin locations.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "postLogoutUris": { "description": "URIs for post logout from client.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "redirectUris": { "description": "URLs for redirection.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "tokenUri": { "description": "URL for token.", "type": "string" }, "userUri": { "description": "URL for user information.", "type": "string" } }, "required": [ "authUri", "checkSessionUri", "clientId", "clientName", "endSessionUri", "frontChannelLogoutUrl", "grantTypes", "idpId", "javascriptOrigins", "postLogoutUris", "redirectUris", "tokenUri", "userUri" ], "type": "object" }, "provider": { "additionalProperties": false, "description": "Mapping of authorization policy URLs to OpenID Connect (OIDC) URLs.", "properties": { "authPolicyUrl": { "description": "The URL from the authorization policy.", "type": "string" }, "oidcUrl": { "description": "The URL for the OpenID Connect (OIDC).", "type": "string" } }, "required": [ "authPolicyUrl", "oidcUrl" ], "type": "object" } }, "required": [ "client", "provider" ], "type": "object" }, "allowUnauthenticated": { "description": "Allows unauthenticated users.", "type": "boolean" }, "enabled": { "description": "Enables an authorization policy.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the authorization policy.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpPreAuthConsent": { "description": "Indicates IDP pre-authorization consent.", "type": "boolean" }, "retryAuthForUnauthenticatedSessions": { "description": "The number of retries for an unauthenticated session.", "minimum": 0, "type": "integer" }, "sessionTtl": { "description": "The duration of a session.", "minimum": 0, "type": "integer" }, "userInfoRefreshTime": { "description": "__Read-only__ ISO 8601 timestamp marking the last user authentication refresh.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "Oidc", "enabled", "id", "idpPreAuthConsent", "allowUnauthenticated", "retryAuthForUnauthenticatedSessions", "sessionTtl", "userInfoRefreshTime" ], "type": "object" }, "authenticationMode": { "description": "Specifies the authentication mode. Either `REQUIRED`, `OPTIONAL`, or `NONE`.", "enum": [ "REQUIRED", "OPTIONAL", "NONE" ], "type": "string" }, "avcSettings": { "additionalProperties": false, "description": "Contains the AVC setting properties.", "properties": { "applicationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "categorySettings": { "description": "Lists the AVC category setting properties.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "Contains data for a category.", "properties": { "code": { "description": "The acceptable use policy categorization code.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The selected default action for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the category.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the category.", "minLength": 1, "type": "string" } }, "required": [ "name", "code", "defaultActionId", "deprecated", "id" ], "type": "object" }, "description": { "description": "Description for the category settings.", "minLength": 1, "type": "string" }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "Contains response data.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "description", "categoryId", "categoryInfo", "groups", "operationSettings", "response", "responseId", "responseOverrides", "users" ], "type": "object" }, "minItems": 0, "type": "array" }, "riskSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "applicationSettings", "categorySettings", "riskSettings" ], "type": "object" }, "basicSettings": { "additionalProperties": false, "description": "Contains the basic policy settings.", "properties": { "dnssec": { "description": "When enabled, provides DNS security.", "type": "boolean" }, "edns0ecs": { "description": "When enabled, optimizes CDN traffic using the `EDNS-Client-Subnet` extension.", "type": "boolean" }, "forwardProxyEnabled": { "description": "Enables the forward proxy.", "type": "boolean" }, "proxyEnabled": { "description": "Enables the proxy.", "type": "boolean" }, "safesearch": { "description": "Enables the safe search feature.", "type": "boolean" }, "trustXFF": { "description": "Enables trust of `X-Forwarded-For` headers.", "type": "boolean" } }, "required": [ "dnssec", "edns0ecs" ], "type": "object" }, "classifiers": { "additionalProperties": false, "description": "Contains classifier details for a policy.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis for a classifier.", "type": "boolean" }, "enabled": { "description": "Enables the classifier.", "type": "boolean" }, "name": { "description": "Name of the classifier.", "minLength": 1, "type": "string" }, "sizeExceedingAction": { "description": "The size exceeded action.", "minimum": 0, "type": "integer" }, "zdpEnabled": { "description": "Enables Zero-Day Phishing (ZDP) protection for a classifier.", "type": "boolean" } }, "required": [ "name", "dynamicAnalysisEnabled", "enabled", "sizeExceedingAction", "zdpEnabled" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this policy.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "customHeaders": { "description": "Lists the policy custom header settings.", "items": { "additionalProperties": false, "description": "Lists the policy custom header object properties.", "properties": { "customHeaderId": { "description": "__Read-only__ The custom header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "domains": { "description": "Lists the domains assigned the custom header.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "headerName": { "description": "Name of the custom header.", "minLength": 1, "type": "string" }, "headerValue": { "description": "Custom header value.", "minLength": 1, "type": "string" } }, "required": [ "customHeaderId", "domains", "headerName", "headerValue" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-custom-header.yaml" } }, "minItems": 0, "type": "array" }, "customRequestHeaders": { "additionalProperties": false, "description": "Lists the policy custom request header settings.", "properties": { "args": { "description": "Lists custom request header arguments.", "items": { "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ The custom request header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "target_domain": { "description": "The target domain for the custom request headers.", "minLength": 1, "type": "string" } }, "required": [ "args", "id", "target_domain" ], "type": "object" }, "description": { "description": "A description of the policy that you provide.", "minLength": 1, "type": "string" }, "dlpExceptions": { "additionalProperties": false, "description": "Lists the DLP exceptions for the policy.", "properties": { "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "groups", "users" ], "type": "object" }, "dlpSettings": { "description": "Data loss prevention (DLP) actions and details.", "items": { "additionalProperties": false, "properties": { "action": { "description": "Action ID for the data loss prevention (DLP) dictionary.", "minimum": 0, "type": "integer" }, "dictionaryId": { "description": "__Read-only__ A unique identifier for the DLP dictionary.", "minimum": 1, "readOnly": true, "type": "integer" }, "dictionaryName": { "description": "Name of the DLP dictionary.", "minLength": 1, "type": "string" }, "dictionarySource": { "description": "Name of the DLP dictionary source.", "minLength": 1, "type": "string" }, "patterns": { "description": "Data loss prevention (DLP) patterns to match.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "threshold": { "description": "The maximum number of DLP patterns to consider.", "minimum": 0, "type": "integer" } }, "required": [ "action", "dictionaryId", "dictionaryName", "dictionarySource", "patterns", "threshold" ], "type": "object" }, "minItems": 0, "type": "array" }, "fWaasSettings": { "description": "Lists firewall as a service settings.", "items": { "additionalProperties": false, "description": "Configures Firewall as service.", "properties": { "appIds": { "description": "Lists app IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "countryCodeInfo": { "description": "Lists country code info.", "items": { "additionalProperties": false, "description": "Specifies firewall as a service geolocation data.", "properties": { "alpha2Code": { "description": "The ISO 3166 two-letter code for the region.", "minLength": 1, "type": "string" }, "alpha3Code": { "description": "The ISO 3166 three-letter code for the region.", "minLength": 1, "type": "string" }, "countryName": { "description": "Name of the firewall service.", "minLength": 1, "type": "string" } }, "required": [ "countryName", "alpha2Code", "alpha3Code" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-geo-info.yaml" } }, "minItems": 0, "type": "array" }, "countryCodes": { "description": "Lists country codes.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "destinationIp": { "description": "Lists destination IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "enabled": { "description": "Enables the service.", "type": "boolean" }, "fWaaSId": { "description": "Unique identifier for the firewall as service.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the service.", "minLength": 1, "type": "string" }, "networkServiceIds": { "description": "Lists network service IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "networkServiceInfo": { "description": "Lists network service info details.", "items": { "additionalProperties": false, "description": "Contains firewall as a service information.", "properties": { "description": { "description": "Name of the firewall as a service.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ Unique identifier for the firewall service.", "minimum": 1, "readOnly": true, "type": "integer" }, "port": { "description": "The port used by the firewall service.", "minLength": 1, "type": "string" }, "protocol": { "description": "Indicates the protocol used by firewall service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "serviceName": { "description": "Name of the Firewall as a Service.", "minLength": 1, "type": "string" } }, "required": [ "description", "id", "serviceName", "port", "protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-info.yaml" } }, "minItems": 0, "type": "array" }, "nonWebAppInfo": { "description": "Lists non-web-app info.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "ports": { "description": "Lists ports.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "protocol": { "description": "Describes the protocol used by service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "rank": { "description": "Priority of the service.", "minimum": 0, "type": "integer" }, "responseId": { "description": "__Read-only__ ID of the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "sourceIp": { "description": "Lists source IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "type": { "description": "Specifies the service type, either `IP`, `APP`, `NETWORK_SERVICE`, `GEO`, or `DEFAULT`.", "enum": [ "IP", "APP", "NETWORK_SERVICE", "GEO", "DEFAULT" ], "type": "string" } }, "required": [ "name", "type", "fWaaSId", "rank", "enabled", "responseId", "sourceIp", "destinationIp", "ports", "protocol", "appIds", "countryCodes", "networkServiceIds", "networkServiceInfo", "countryCodeInfo", "nonWebAppInfo" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-settings.yaml" } }, "minItems": 0, "type": "array" }, "farmId": { "description": "__Read-only__ A unique identifier for policy's farm.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeSettings": { "description": "Lists the filetype settings for the policy.", "items": { "additionalProperties": false, "description": "Lists the file type setting parameters.", "properties": { "applyTo": { "description": "Lists policies to apply the file type settings to.", "minLength": 1, "type": "string" }, "fileTypeId": { "description": "__Read-only__ Identifies each file type.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeInfo": { "additionalProperties": false, "description": "Contains file type info properties.", "properties": { "category": { "description": "The file category.", "minLength": 1, "type": "string" }, "code": { "description": "The file's code.", "minLength": 1, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The file's default action ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the file.", "type": "boolean" }, "id": { "description": "__Read-only__ Lists the file ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The filename.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "category", "defaultActionId", "deprecated", "code" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-info.yaml" } }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "name": { "description": "Name of the file type.", "minLength": 1, "type": "string" }, "responseId": { "description": "__Read-only__ Lists the response ID for the file type setting.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Provides details about response.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseOverrides": { "description": "Contains the AVC response override details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "type": { "description": "Lists the file type.", "minLength": 1, "type": "string" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "type", "responseId", "fileTypeId", "users", "groups", "responseInfo", "responseOverrides", "fileTypeInfo", "applyTo" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-settings.yaml" } }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ A unique identifier for each policy. Use this value for a `policyId` parameter in subsequent operations.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpId": { "description": "__Read-only__ A unique identifier for the associated identity provider.", "minLength": 1, "readOnly": true, "type": "string" }, "ipaSettings": { "additionalProperties": false, "description": "Contains IPA settings.", "properties": { "blockOnUploadScanTimeout": { "description": "Blocks on upload scan timeout.", "type": "boolean" }, "blockUnscannableFiles": { "description": "Blocks unscannable files.", "type": "boolean" }, "enabled": { "description": "Enables IPA.", "type": "boolean" }, "randomCheck": { "description": "Enables random check for `ipaSettings`.", "type": "boolean" }, "zdp": { "description": "Enables Zero-Day Phishing (ZDP) protection.", "type": "boolean" } }, "required": [ "enabled", "randomCheck", "zdp" ], "type": "object" }, "modifiedBy": { "description": "Name of the user who most recently modified this policy.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the policy.", "minLength": 1, "type": "string" }, "originPorts": { "description": "Lists origin ports for a policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "originValidationFailActionId": { "description": "__Read-only__ A unique identifier for a validation fail action.", "minimum": 1, "readOnly": true, "type": "integer" }, "policyGeneralSettings": { "additionalProperties": false, "description": "Specifies the policy's general settings.", "properties": { "androidDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "aupMigrated": { "description": "Migrates acceptable use policy.", "type": "boolean" }, "avcEnabled": { "description": "Enables the AVC.", "type": "boolean" }, "blockBrokenTLS": { "description": "Blocks broken TLS traffic.", "type": "boolean" }, "bypassO365": { "description": "Bypasses Microsoft Office 365 traffic.", "type": "boolean" }, "chromeOSDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "classifyMigrated": { "description": "Migrates classify information.", "type": "boolean" }, "disableClient": { "description": "Disables the SIA client.", "type": "boolean" }, "disableInsecureCiphers": { "description": "Disables insecure ciphers.", "type": "boolean" }, "dotConfig": { "additionalProperties": false, "description": "Contains DNS over TLS configuration.", "properties": { "mode": { "description": "The DNS over TLS mode:\n- `ATTEMPT` always tries to use DOT and falls back to standard DNS when unavailable.\n- `REQUIRED` requires DOT and informs the client the device isn't protected.\n- `DISABLED` doesn't apply DOT to secure DNS traffic.", "enum": [ "ATTEMPT", "REQUIRED", "DISABLED" ], "type": "string" }, "port": { "description": "The assigned port for `dotConfig`.", "minimum": 0, "type": "integer" } }, "required": [ "mode", "port" ], "type": "object" }, "enableIPIntelligence": { "description": "Enables IP intelligence.", "type": "boolean" }, "etpClientMultiUserEnabled": { "description": "Enables multi-user on the SIA client.", "type": "boolean" }, "fwaasEnabled": { "description": "Enables Firewall as a Service.", "type": "boolean" }, "httpProxyOverride": { "description": "Represents HTTP proxy override priority.", "minimum": 0, "type": "integer" }, "iOSDefaultAction": { "description": "Specifies the default action on iOS devices.", "minimum": 0, "type": "integer" }, "idpUserInfoRetryInterval": { "description": "Specifies the retry interval value for IDP users.", "minimum": 0, "type": "integer" }, "ignoreLocalDNSResolvers": { "description": "Ignores local DNS resolution.", "type": "boolean" }, "localBreakoutForBypass": { "description": "Enables local breakout for bypass.", "type": "boolean" }, "proxyAuthEnabled": { "description": "Enables proxy authentication.", "type": "boolean" }, "wgExceptions": { "description": "Enables walled-garden exceptions.", "type": "boolean" } }, "type": "object" }, "proxyHostname": { "description": "Name of proxy host machine.", "type": "string" }, "riskyFileHandlingSettings": { "additionalProperties": false, "description": "Describes file handling settings.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis.", "type": "boolean" }, "hugeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for huge risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "largeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for large risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "hugeRiskyFileResponse", "largeRiskyFileResponse" ], "type": "object" }, "safeSearchSettings": { "additionalProperties": false, "description": "Contains safe search settings.", "properties": { "youtube": { "description": "Specifies the Youtube access policy, either `open`, `moderate`, or `strict`.", "enum": [ "open", "moderate", "strict" ], "type": "string" } }, "required": [ "youtube" ], "type": "object" }, "securitySettings": { "description": "Contains the policy security settings.", "items": { "additionalProperties": false, "description": "Contains the policy security settings.", "properties": { "confirmedGroups": { "description": "Confirmed groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "confirmedResponseId": { "description": "A unique identifier for the confirmed response.", "minimum": 1, "type": "integer" }, "confirmedResponseInfo": { "additionalProperties": false, "description": "Contains data about the confirmed response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the confirmed response info.", "minimum": 0, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the confirmed response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "confirmedUsers": { "description": "Confirmed users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "listId": { "description": "A unique identifier for the list.", "minimum": 1, "type": "integer" }, "listInfo": { "additionalProperties": false, "description": "List information.", "properties": { "categoryId": { "description": "The unique category ID.", "minimum": 1, "type": "integer" }, "id": { "description": "A unique identifier for the list info.", "minimum": 0, "type": "integer" }, "listType": { "description": "The list type. See [List types](https://techdocs.akamai.com/etp-config/reference/list-types) for details.", "enum": [ "AKAMAI", "TOP_LEVEL_DOMAIN", "WHITELIST", "FILEHASHLIST", "FILEHASH_BLOCK", "DOMAIN_IP_LIST", "URL_BLOCK", "URL_BYPASS" ], "type": "string" }, "name": { "description": "The name of the list info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "categoryId" ], "type": "object" }, "responseOverridesConfirmed": { "description": "Response overrides for confirmed response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "responseOverridesSuspected": { "description": "Response overrides for suspected response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "shouldNotifyConfirmed": { "description": "Send alert on confirmed list hit.", "type": "boolean" }, "shouldNotifySuspected": { "description": "Send alert on suspected list hit.", "type": "boolean" }, "suspectedGroups": { "description": "Suspected groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "suspectedResponseId": { "description": "A unique identifier for the suspected response.", "minimum": 1, "type": "integer" }, "suspectedResponseInfo": { "additionalProperties": false, "description": "Suspected response data.", "properties": { "id": { "description": "A unique identifier for the suspected response info.", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the suspected response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "suspectedUsers": { "description": "Suspected users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "listId", "confirmedResponseId", "shouldNotifyConfirmed", "shouldNotifySuspected" ], "type": "object", "x-akamai": { "file-path": "schemas/security-settings-info.yaml" } }, "minItems": 0, "type": "array" }, "sites": { "description": "Contains associated site IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "sitesInfo": { "description": "Contains data about associated sites.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the site.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the site.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "sublocationInfo": { "description": "Lists sublocation info.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id-name.yaml" } }, "minItems": 0, "type": "array" }, "sublocations": { "description": "Lists the sublocations configured for this policy.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "trafficLogging": { "additionalProperties": false, "description": "Provides details of traffic logging in different modes.", "properties": { "headers": { "additionalProperties": false, "description": "Contains header information for traffic.", "properties": { "request": { "additionalProperties": false, "description": "The request details in the header.", "properties": { "mode": { "description": "Request mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" }, "response": { "additionalProperties": false, "description": "The response details in the header.", "properties": { "mode": { "description": "Response mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" } }, "required": [ "request", "response" ], "type": "object" }, "mode": { "description": "The traffic logging mode. Either `full`, `url`, `path`, or `host`.", "enum": [ "full", "url", "path", "host" ], "type": "string" }, "url": { "additionalProperties": false, "description": "URL details of the traffic.", "properties": { "mode": { "description": "The URL mode used for traffic logging. Either `FULL`, `PATH`, or `HOST`.", "enum": [ "FULL", "PATH", "HOST" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } }, "required": [ "headers", "mode", "url" ], "type": "object" } }, "required": [ "description", "name", "aupSettings", "securitySettings" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-retrieve-specific.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/policy-retrieve-all.yaml" } } } }, "description": "Policy metadata with details." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List policies", "tags": [ "Policies" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/policies.yaml", "path-info": "/configs/{configId}/policies" } }, "/configs/{configId}/policies/{policyId}": { "get": { "description": "Returns the details of a policy.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-policy" }, "operationId": "get-policy", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "accessConfig": { "configurable": true, "delegatedAdmins": [ "delegatedAdmin@org.com" ], "readable": true }, "akamaiDefined": true, "aupSettings": [ { "categoryId": 1, "categoryInfo": { "code": "AKA-SOCIAL", "defaultActionId": 5, "deprecated": false, "id": 1, "name": "Social" }, "groups": [ "GroupName1" ], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [ { "id": 4, "name": "Block" } ], "users": [ "usr1@org.com", "bjones@org.com" ] } ], "authenticationMode": "NONE", "basicSettings": { "dnssec": false, "edns0ecs": true, "forwardProxyEnabled": false, "proxyEnabled": false, "safesearch": false, "trustXFF": false }, "createdBy": "hgildong", "createdDate": "2021-06-25T20:20:33.114+0000", "description": "Default policy", "id": 2480, "ipaSettings": { "enabled": false, "randomCheck": false, "zdp": false }, "modifiedBy": "alfulani", "modifiedDate": "2022-04-12T21:08:57.108+0000", "name": "Default", "policyGeneralSettings": { "bypassO365": false, "disableClient": false, "disableInsecureCiphers": false, "dotConfig": { "mode": "ATTEMPT", "port": 443 }, "httpProxyOverride": 0, "localBreakoutForBypass": true, "proxyAuthEnabled": false, "wgExceptions": false }, "riskyFileHandlingSettings": { "hugeRiskyFileResponse": { "id": 5, "name": "Allow" }, "largeRiskyFileResponse": { "id": 5, "name": "Allow" } }, "safeSearchSettings": { "youtube": "open" }, "securitySettings": [ { "confirmedResponseId": 760, "confirmedResponseInfo": { "id": 760, "name": "Sinkhole 1" }, "listId": 1, "listInfo": { "categoryId": 1, "id": 1, "name": "Malware" }, "shouldNotifyConfirmed": true, "shouldNotifySuspected": true, "suspectedResponseId": 760, "suspectedResponseInfo": { "id": 760, "name": "Sinkhole 1" } }, { "confirmedResponseId": 1, "confirmedResponseInfo": { "id": 1, "name": "Monitor" }, "listId": 5601, "listInfo": { "categoryId": 1, "id": 5601, "name": "luis list" }, "shouldNotifyConfirmed": false, "shouldNotifySuspected": false, "suspectedResponseId": 1, "suspectedResponseInfo": { "id": 1, "name": "Monitor" } } ], "sites": [ 2160, 18217, 991731, 991733 ], "sitesInfo": [ { "id": 2160, "name": "Unidentified IPs" }, { "id": 18217, "name": "DDNS" }, { "id": 991731, "name": "aasdfsadfdsa" }, { "id": 991733, "name": "11adakjsdhfkjaslhdfkjlashldfkljashdfjashdfasdfasdfsakjhasjkdfhkaljshdfkljhasfadfasfdasdfasdfsadf" } ] }, "schema": { "additionalProperties": false, "description": "The security policy to assign to a site. Configure the accepted use policy and set responses for known and suspected threats under the specified categories.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Marks a policy as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated administrators for the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks a policy as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "akamaiDefined": { "description": "Marks a policy as Akamai-defined.", "type": "boolean" }, "aupSettings": { "description": "Contains the acceptable use policy settings.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AUP category data.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "groups": { "description": "Groups users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Describes the operation settings on the AUP setting.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Lists user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "categoryId" ], "type": "object" }, "minItems": 0, "type": "array" }, "aupSource": { "description": "Name of acceptable use policy source for the policy.", "minLength": 1, "type": "string" }, "authPolicy": { "additionalProperties": false, "description": "Details of the authorization policy adopted for the policy.", "properties": { "Oidc": { "additionalProperties": false, "description": "Provides OpenID Connect (OIDC) provider and client details.", "properties": { "client": { "additionalProperties": false, "description": "Provides information about a client.", "properties": { "authUri": { "description": "URL for authorization.", "type": "string" }, "checkSessionUri": { "description": "URL to check if session is alive.", "type": "string" }, "clientId": { "description": "__Read-only__ A unique identifier for the client.", "minimum": 1, "readOnly": true, "type": "integer" }, "clientName": { "description": "Name of the client.", "minLength": 1, "type": "string" }, "endSessionUri": { "description": "URL for ending session.", "type": "string" }, "frontChannelLogoutUrl": { "description": "URLs for logout from front channel.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "grantTypes": { "description": "Client grant types.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "idpId": { "description": "__Read-only__ A unique identifier for the IDP for the OIDC.", "minLength": 1, "readOnly": true, "type": "string" }, "javascriptOrigins": { "description": "JavaScript origin locations.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "postLogoutUris": { "description": "URIs for post logout from client.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "redirectUris": { "description": "URLs for redirection.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "tokenUri": { "description": "URL for token.", "type": "string" }, "userUri": { "description": "URL for user information.", "type": "string" } }, "required": [ "authUri", "checkSessionUri", "clientId", "clientName", "endSessionUri", "frontChannelLogoutUrl", "grantTypes", "idpId", "javascriptOrigins", "postLogoutUris", "redirectUris", "tokenUri", "userUri" ], "type": "object" }, "provider": { "additionalProperties": false, "description": "Mapping of authorization policy URLs to OpenID Connect (OIDC) URLs.", "properties": { "authPolicyUrl": { "description": "The URL from the authorization policy.", "type": "string" }, "oidcUrl": { "description": "The URL for the OpenID Connect (OIDC).", "type": "string" } }, "required": [ "authPolicyUrl", "oidcUrl" ], "type": "object" } }, "required": [ "client", "provider" ], "type": "object" }, "allowUnauthenticated": { "description": "Allows unauthenticated users.", "type": "boolean" }, "enabled": { "description": "Enables an authorization policy.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the authorization policy.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpPreAuthConsent": { "description": "Indicates IDP pre-authorization consent.", "type": "boolean" }, "retryAuthForUnauthenticatedSessions": { "description": "The number of retries for an unauthenticated session.", "minimum": 0, "type": "integer" }, "sessionTtl": { "description": "The duration of a session.", "minimum": 0, "type": "integer" }, "userInfoRefreshTime": { "description": "__Read-only__ ISO 8601 timestamp marking the last user authentication refresh.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "Oidc", "enabled", "id", "idpPreAuthConsent", "allowUnauthenticated", "retryAuthForUnauthenticatedSessions", "sessionTtl", "userInfoRefreshTime" ], "type": "object" }, "authenticationMode": { "description": "Specifies the authentication mode. Either `REQUIRED`, `OPTIONAL`, or `NONE`.", "enum": [ "REQUIRED", "OPTIONAL", "NONE" ], "type": "string" }, "avcSettings": { "additionalProperties": false, "description": "Contains the AVC setting properties.", "properties": { "applicationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "categorySettings": { "description": "Lists the AVC category setting properties.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "Contains data for a category.", "properties": { "code": { "description": "The acceptable use policy categorization code.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The selected default action for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the category.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the category.", "minLength": 1, "type": "string" } }, "required": [ "name", "code", "defaultActionId", "deprecated", "id" ], "type": "object" }, "description": { "description": "Description for the category settings.", "minLength": 1, "type": "string" }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "Contains response data.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "description", "categoryId", "categoryInfo", "groups", "operationSettings", "response", "responseId", "responseOverrides", "users" ], "type": "object" }, "minItems": 0, "type": "array" }, "riskSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "applicationSettings", "categorySettings", "riskSettings" ], "type": "object" }, "basicSettings": { "additionalProperties": false, "description": "Contains the basic policy settings.", "properties": { "dnssec": { "description": "When enabled, provides DNS security.", "type": "boolean" }, "edns0ecs": { "description": "When enabled, optimizes CDN traffic using the `EDNS-Client-Subnet` extension.", "type": "boolean" }, "forwardProxyEnabled": { "description": "Enables the forward proxy.", "type": "boolean" }, "proxyEnabled": { "description": "Enables the proxy.", "type": "boolean" }, "safesearch": { "description": "Enables the safe search feature.", "type": "boolean" }, "trustXFF": { "description": "Enables trust of `X-Forwarded-For` headers.", "type": "boolean" } }, "required": [ "dnssec", "edns0ecs" ], "type": "object" }, "classifiers": { "additionalProperties": false, "description": "Contains classifier details for a policy.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis for a classifier.", "type": "boolean" }, "enabled": { "description": "Enables the classifier.", "type": "boolean" }, "name": { "description": "Name of the classifier.", "minLength": 1, "type": "string" }, "sizeExceedingAction": { "description": "The size exceeded action.", "minimum": 0, "type": "integer" }, "zdpEnabled": { "description": "Enables Zero-Day Phishing (ZDP) protection for a classifier.", "type": "boolean" } }, "required": [ "name", "dynamicAnalysisEnabled", "enabled", "sizeExceedingAction", "zdpEnabled" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this policy.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "customHeaders": { "description": "Lists the policy custom header settings.", "items": { "additionalProperties": false, "description": "Lists the policy custom header object properties.", "properties": { "customHeaderId": { "description": "__Read-only__ The custom header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "domains": { "description": "Lists the domains assigned the custom header.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "headerName": { "description": "Name of the custom header.", "minLength": 1, "type": "string" }, "headerValue": { "description": "Custom header value.", "minLength": 1, "type": "string" } }, "required": [ "customHeaderId", "domains", "headerName", "headerValue" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-custom-header.yaml" } }, "minItems": 0, "type": "array" }, "customRequestHeaders": { "additionalProperties": false, "description": "Lists the policy custom request header settings.", "properties": { "args": { "description": "Lists custom request header arguments.", "items": { "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ The custom request header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "target_domain": { "description": "The target domain for the custom request headers.", "minLength": 1, "type": "string" } }, "required": [ "args", "id", "target_domain" ], "type": "object" }, "description": { "description": "A description of the policy that you provide.", "minLength": 1, "type": "string" }, "dlpExceptions": { "additionalProperties": false, "description": "Lists the DLP exceptions for the policy.", "properties": { "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "groups", "users" ], "type": "object" }, "dlpSettings": { "description": "Data loss prevention (DLP) actions and details.", "items": { "additionalProperties": false, "properties": { "action": { "description": "Action ID for the data loss prevention (DLP) dictionary.", "minimum": 0, "type": "integer" }, "dictionaryId": { "description": "__Read-only__ A unique identifier for the DLP dictionary.", "minimum": 1, "readOnly": true, "type": "integer" }, "dictionaryName": { "description": "Name of the DLP dictionary.", "minLength": 1, "type": "string" }, "dictionarySource": { "description": "Name of the DLP dictionary source.", "minLength": 1, "type": "string" }, "patterns": { "description": "Data loss prevention (DLP) patterns to match.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "threshold": { "description": "The maximum number of DLP patterns to consider.", "minimum": 0, "type": "integer" } }, "required": [ "action", "dictionaryId", "dictionaryName", "dictionarySource", "patterns", "threshold" ], "type": "object" }, "minItems": 0, "type": "array" }, "fWaasSettings": { "description": "Lists firewall as a service settings.", "items": { "additionalProperties": false, "description": "Configures Firewall as service.", "properties": { "appIds": { "description": "Lists app IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "countryCodeInfo": { "description": "Lists country code info.", "items": { "additionalProperties": false, "description": "Specifies firewall as a service geolocation data.", "properties": { "alpha2Code": { "description": "The ISO 3166 two-letter code for the region.", "minLength": 1, "type": "string" }, "alpha3Code": { "description": "The ISO 3166 three-letter code for the region.", "minLength": 1, "type": "string" }, "countryName": { "description": "Name of the firewall service.", "minLength": 1, "type": "string" } }, "required": [ "countryName", "alpha2Code", "alpha3Code" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-geo-info.yaml" } }, "minItems": 0, "type": "array" }, "countryCodes": { "description": "Lists country codes.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "destinationIp": { "description": "Lists destination IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "enabled": { "description": "Enables the service.", "type": "boolean" }, "fWaaSId": { "description": "Unique identifier for the firewall as service.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the service.", "minLength": 1, "type": "string" }, "networkServiceIds": { "description": "Lists network service IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "networkServiceInfo": { "description": "Lists network service info details.", "items": { "additionalProperties": false, "description": "Contains firewall as a service information.", "properties": { "description": { "description": "Name of the firewall as a service.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ Unique identifier for the firewall service.", "minimum": 1, "readOnly": true, "type": "integer" }, "port": { "description": "The port used by the firewall service.", "minLength": 1, "type": "string" }, "protocol": { "description": "Indicates the protocol used by firewall service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "serviceName": { "description": "Name of the Firewall as a Service.", "minLength": 1, "type": "string" } }, "required": [ "description", "id", "serviceName", "port", "protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-info.yaml" } }, "minItems": 0, "type": "array" }, "nonWebAppInfo": { "description": "Lists non-web-app info.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "ports": { "description": "Lists ports.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "protocol": { "description": "Describes the protocol used by service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "rank": { "description": "Priority of the service.", "minimum": 0, "type": "integer" }, "responseId": { "description": "__Read-only__ ID of the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "sourceIp": { "description": "Lists source IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "type": { "description": "Specifies the service type, either `IP`, `APP`, `NETWORK_SERVICE`, `GEO`, or `DEFAULT`.", "enum": [ "IP", "APP", "NETWORK_SERVICE", "GEO", "DEFAULT" ], "type": "string" } }, "required": [ "name", "type", "fWaaSId", "rank", "enabled", "responseId", "sourceIp", "destinationIp", "ports", "protocol", "appIds", "countryCodes", "networkServiceIds", "networkServiceInfo", "countryCodeInfo", "nonWebAppInfo" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-settings.yaml" } }, "minItems": 0, "type": "array" }, "farmId": { "description": "__Read-only__ A unique identifier for policy's farm.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeSettings": { "description": "Lists the filetype settings for the policy.", "items": { "additionalProperties": false, "description": "Lists the file type setting parameters.", "properties": { "applyTo": { "description": "Lists policies to apply the file type settings to.", "minLength": 1, "type": "string" }, "fileTypeId": { "description": "__Read-only__ Identifies each file type.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeInfo": { "additionalProperties": false, "description": "Contains file type info properties.", "properties": { "category": { "description": "The file category.", "minLength": 1, "type": "string" }, "code": { "description": "The file's code.", "minLength": 1, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The file's default action ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the file.", "type": "boolean" }, "id": { "description": "__Read-only__ Lists the file ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The filename.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "category", "defaultActionId", "deprecated", "code" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-info.yaml" } }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "name": { "description": "Name of the file type.", "minLength": 1, "type": "string" }, "responseId": { "description": "__Read-only__ Lists the response ID for the file type setting.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Provides details about response.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseOverrides": { "description": "Contains the AVC response override details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "type": { "description": "Lists the file type.", "minLength": 1, "type": "string" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "type", "responseId", "fileTypeId", "users", "groups", "responseInfo", "responseOverrides", "fileTypeInfo", "applyTo" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-settings.yaml" } }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ A unique identifier for each policy. Use this value for a `policyId` parameter in subsequent operations.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpId": { "description": "__Read-only__ A unique identifier for the associated identity provider.", "minLength": 1, "readOnly": true, "type": "string" }, "ipaSettings": { "additionalProperties": false, "description": "Contains IPA settings.", "properties": { "blockOnUploadScanTimeout": { "description": "Blocks on upload scan timeout.", "type": "boolean" }, "blockUnscannableFiles": { "description": "Blocks unscannable files.", "type": "boolean" }, "enabled": { "description": "Enables IPA.", "type": "boolean" }, "randomCheck": { "description": "Enables random check for `ipaSettings`.", "type": "boolean" }, "zdp": { "description": "Enables Zero-Day Phishing (ZDP) protection.", "type": "boolean" } }, "required": [ "enabled", "randomCheck", "zdp" ], "type": "object" }, "modifiedBy": { "description": "Name of the user who most recently modified this policy.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the policy.", "minLength": 1, "type": "string" }, "originPorts": { "description": "Lists origin ports for a policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "originValidationFailActionId": { "description": "__Read-only__ A unique identifier for a validation fail action.", "minimum": 1, "readOnly": true, "type": "integer" }, "policyGeneralSettings": { "additionalProperties": false, "description": "Specifies the policy's general settings.", "properties": { "androidDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "aupMigrated": { "description": "Migrates acceptable use policy.", "type": "boolean" }, "avcEnabled": { "description": "Enables the AVC.", "type": "boolean" }, "blockBrokenTLS": { "description": "Blocks broken TLS traffic.", "type": "boolean" }, "bypassO365": { "description": "Bypasses Microsoft Office 365 traffic.", "type": "boolean" }, "chromeOSDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "classifyMigrated": { "description": "Migrates classify information.", "type": "boolean" }, "disableClient": { "description": "Disables the SIA client.", "type": "boolean" }, "disableInsecureCiphers": { "description": "Disables insecure ciphers.", "type": "boolean" }, "dotConfig": { "additionalProperties": false, "description": "Contains DNS over TLS configuration.", "properties": { "mode": { "description": "The DNS over TLS mode:\n- `ATTEMPT` always tries to use DOT and falls back to standard DNS when unavailable.\n- `REQUIRED` requires DOT and informs the client the device isn't protected.\n- `DISABLED` doesn't apply DOT to secure DNS traffic.", "enum": [ "ATTEMPT", "REQUIRED", "DISABLED" ], "type": "string" }, "port": { "description": "The assigned port for `dotConfig`.", "minimum": 0, "type": "integer" } }, "required": [ "mode", "port" ], "type": "object" }, "enableIPIntelligence": { "description": "Enables IP intelligence.", "type": "boolean" }, "etpClientMultiUserEnabled": { "description": "Enables multi-user on the SIA client.", "type": "boolean" }, "fwaasEnabled": { "description": "Enables Firewall as a Service.", "type": "boolean" }, "httpProxyOverride": { "description": "Represents HTTP proxy override priority.", "minimum": 0, "type": "integer" }, "iOSDefaultAction": { "description": "Specifies the default action on iOS devices.", "minimum": 0, "type": "integer" }, "idpUserInfoRetryInterval": { "description": "Specifies the retry interval value for IDP users.", "minimum": 0, "type": "integer" }, "ignoreLocalDNSResolvers": { "description": "Ignores local DNS resolution.", "type": "boolean" }, "localBreakoutForBypass": { "description": "Enables local breakout for bypass.", "type": "boolean" }, "proxyAuthEnabled": { "description": "Enables proxy authentication.", "type": "boolean" }, "wgExceptions": { "description": "Enables walled-garden exceptions.", "type": "boolean" } }, "type": "object" }, "proxyHostname": { "description": "Name of proxy host machine.", "type": "string" }, "riskyFileHandlingSettings": { "additionalProperties": false, "description": "Describes file handling settings.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis.", "type": "boolean" }, "hugeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for huge risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "largeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for large risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "hugeRiskyFileResponse", "largeRiskyFileResponse" ], "type": "object" }, "safeSearchSettings": { "additionalProperties": false, "description": "Contains safe search settings.", "properties": { "youtube": { "description": "Specifies the Youtube access policy, either `open`, `moderate`, or `strict`.", "enum": [ "open", "moderate", "strict" ], "type": "string" } }, "required": [ "youtube" ], "type": "object" }, "securitySettings": { "description": "Contains the policy security settings.", "items": { "additionalProperties": false, "description": "Contains the policy security settings.", "properties": { "confirmedGroups": { "description": "Confirmed groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "confirmedResponseId": { "description": "A unique identifier for the confirmed response.", "minimum": 1, "type": "integer" }, "confirmedResponseInfo": { "additionalProperties": false, "description": "Contains data about the confirmed response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the confirmed response info.", "minimum": 0, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the confirmed response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "confirmedUsers": { "description": "Confirmed users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "listId": { "description": "A unique identifier for the list.", "minimum": 1, "type": "integer" }, "listInfo": { "additionalProperties": false, "description": "List information.", "properties": { "categoryId": { "description": "The unique category ID.", "minimum": 1, "type": "integer" }, "id": { "description": "A unique identifier for the list info.", "minimum": 0, "type": "integer" }, "listType": { "description": "The list type. See [List types](https://techdocs.akamai.com/etp-config/reference/list-types) for details.", "enum": [ "AKAMAI", "TOP_LEVEL_DOMAIN", "WHITELIST", "FILEHASHLIST", "FILEHASH_BLOCK", "DOMAIN_IP_LIST", "URL_BLOCK", "URL_BYPASS" ], "type": "string" }, "name": { "description": "The name of the list info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "categoryId" ], "type": "object" }, "responseOverridesConfirmed": { "description": "Response overrides for confirmed response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "responseOverridesSuspected": { "description": "Response overrides for suspected response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "shouldNotifyConfirmed": { "description": "Send alert on confirmed list hit.", "type": "boolean" }, "shouldNotifySuspected": { "description": "Send alert on suspected list hit.", "type": "boolean" }, "suspectedGroups": { "description": "Suspected groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "suspectedResponseId": { "description": "A unique identifier for the suspected response.", "minimum": 1, "type": "integer" }, "suspectedResponseInfo": { "additionalProperties": false, "description": "Suspected response data.", "properties": { "id": { "description": "A unique identifier for the suspected response info.", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the suspected response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "suspectedUsers": { "description": "Suspected users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "listId", "confirmedResponseId", "shouldNotifyConfirmed", "shouldNotifySuspected" ], "type": "object", "x-akamai": { "file-path": "schemas/security-settings-info.yaml" } }, "minItems": 0, "type": "array" }, "sites": { "description": "Contains associated site IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "sitesInfo": { "description": "Contains data about associated sites.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the site.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the site.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "sublocationInfo": { "description": "Lists sublocation info.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id-name.yaml" } }, "minItems": 0, "type": "array" }, "sublocations": { "description": "Lists the sublocations configured for this policy.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "trafficLogging": { "additionalProperties": false, "description": "Provides details of traffic logging in different modes.", "properties": { "headers": { "additionalProperties": false, "description": "Contains header information for traffic.", "properties": { "request": { "additionalProperties": false, "description": "The request details in the header.", "properties": { "mode": { "description": "Request mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" }, "response": { "additionalProperties": false, "description": "The response details in the header.", "properties": { "mode": { "description": "Response mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" } }, "required": [ "request", "response" ], "type": "object" }, "mode": { "description": "The traffic logging mode. Either `full`, `url`, `path`, or `host`.", "enum": [ "full", "url", "path", "host" ], "type": "string" }, "url": { "additionalProperties": false, "description": "URL details of the traffic.", "properties": { "mode": { "description": "The URL mode used for traffic logging. Either `FULL`, `PATH`, or `HOST`.", "enum": [ "FULL", "PATH", "HOST" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } }, "required": [ "headers", "mode", "url" ], "type": "object" } }, "required": [ "description", "name", "aupSettings", "securitySettings" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-retrieve-specific.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get a policy", "tags": [ "Policies" ] }, "put": { "description": "Modifies the specified policy.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-policy" }, "operationId": "put-policy", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "aupSettings": [ { "categoryId": 2, "responseId": 2 } ], "basicSettings": { "dnssec": false, "edns0ecs": false }, "description": "APAC sites", "id": 120, "name": "APAC_policy", "securitySettings": [ { "confirmedResponseId": 1, "listId": 1, "shouldNotifyConfirmed": true, "shouldNotifySuspected": true, "suspectedResponseId": 1 } ], "sites": [ 100 ] }, "schema": { "additionalProperties": false, "description": "The security policy to assign to a site. Configure the accepted use policy and set responses for known and suspected threats under the specified categories.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Marks a policy as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated administrators for the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks a policy as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "akamaiDefined": { "description": "Marks a policy as Akamai-defined.", "type": "boolean" }, "aupSettings": { "description": "Contains the acceptable use policy settings.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AUP category data.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "groups": { "description": "Groups users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Describes the operation settings on the AUP setting.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Lists user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "categoryId" ], "type": "object" }, "minItems": 0, "type": "array" }, "aupSource": { "description": "Name of acceptable use policy source for the policy.", "minLength": 1, "type": "string" }, "authPolicy": { "additionalProperties": false, "description": "Details of the authorization policy adopted for the policy.", "properties": { "Oidc": { "additionalProperties": false, "description": "Provides OpenID Connect (OIDC) provider and client details.", "properties": { "client": { "additionalProperties": false, "description": "Provides information about a client.", "properties": { "authUri": { "description": "URL for authorization.", "type": "string" }, "checkSessionUri": { "description": "URL to check if session is alive.", "type": "string" }, "clientId": { "description": "__Read-only__ A unique identifier for the client.", "minimum": 1, "readOnly": true, "type": "integer" }, "clientName": { "description": "Name of the client.", "minLength": 1, "type": "string" }, "endSessionUri": { "description": "URL for ending session.", "type": "string" }, "frontChannelLogoutUrl": { "description": "URLs for logout from front channel.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "grantTypes": { "description": "Client grant types.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "idpId": { "description": "__Read-only__ A unique identifier for the IDP for the OIDC.", "minLength": 1, "readOnly": true, "type": "string" }, "javascriptOrigins": { "description": "JavaScript origin locations.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "postLogoutUris": { "description": "URIs for post logout from client.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "redirectUris": { "description": "URLs for redirection.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "tokenUri": { "description": "URL for token.", "type": "string" }, "userUri": { "description": "URL for user information.", "type": "string" } }, "required": [ "authUri", "checkSessionUri", "clientId", "clientName", "endSessionUri", "frontChannelLogoutUrl", "grantTypes", "idpId", "javascriptOrigins", "postLogoutUris", "redirectUris", "tokenUri", "userUri" ], "type": "object" }, "provider": { "additionalProperties": false, "description": "Mapping of authorization policy URLs to OpenID Connect (OIDC) URLs.", "properties": { "authPolicyUrl": { "description": "The URL from the authorization policy.", "type": "string" }, "oidcUrl": { "description": "The URL for the OpenID Connect (OIDC).", "type": "string" } }, "required": [ "authPolicyUrl", "oidcUrl" ], "type": "object" } }, "required": [ "client", "provider" ], "type": "object" }, "allowUnauthenticated": { "description": "Allows unauthenticated users.", "type": "boolean" }, "enabled": { "description": "Enables an authorization policy.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the authorization policy.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpPreAuthConsent": { "description": "Indicates IDP pre-authorization consent.", "type": "boolean" }, "retryAuthForUnauthenticatedSessions": { "description": "The number of retries for an unauthenticated session.", "minimum": 0, "type": "integer" }, "sessionTtl": { "description": "The duration of a session.", "minimum": 0, "type": "integer" }, "userInfoRefreshTime": { "description": "__Read-only__ ISO 8601 timestamp marking the last user authentication refresh.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "Oidc", "enabled", "id", "idpPreAuthConsent", "allowUnauthenticated", "retryAuthForUnauthenticatedSessions", "sessionTtl", "userInfoRefreshTime" ], "type": "object" }, "authenticationMode": { "description": "Specifies the authentication mode. Either `REQUIRED`, `OPTIONAL`, or `NONE`.", "enum": [ "REQUIRED", "OPTIONAL", "NONE" ], "type": "string" }, "avcSettings": { "additionalProperties": false, "description": "Contains the AVC setting properties.", "properties": { "applicationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "categorySettings": { "description": "Lists the AVC category setting properties.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "Contains data for a category.", "properties": { "code": { "description": "The acceptable use policy categorization code.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The selected default action for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the category.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the category.", "minLength": 1, "type": "string" } }, "required": [ "name", "code", "defaultActionId", "deprecated", "id" ], "type": "object" }, "description": { "description": "Description for the category settings.", "minLength": 1, "type": "string" }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "Contains response data.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "description", "categoryId", "categoryInfo", "groups", "operationSettings", "response", "responseId", "responseOverrides", "users" ], "type": "object" }, "minItems": 0, "type": "array" }, "riskSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "applicationSettings", "categorySettings", "riskSettings" ], "type": "object" }, "basicSettings": { "additionalProperties": false, "description": "Contains the basic policy settings.", "properties": { "dnssec": { "description": "When enabled, provides DNS security.", "type": "boolean" }, "edns0ecs": { "description": "When enabled, optimizes CDN traffic using the `EDNS-Client-Subnet` extension.", "type": "boolean" }, "forwardProxyEnabled": { "description": "Enables the forward proxy.", "type": "boolean" }, "proxyEnabled": { "description": "Enables the proxy.", "type": "boolean" }, "safesearch": { "description": "Enables the safe search feature.", "type": "boolean" }, "trustXFF": { "description": "Enables trust of `X-Forwarded-For` headers.", "type": "boolean" } }, "required": [ "dnssec", "edns0ecs" ], "type": "object" }, "classifiers": { "additionalProperties": false, "description": "Contains classifier details for a policy.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis for a classifier.", "type": "boolean" }, "enabled": { "description": "Enables the classifier.", "type": "boolean" }, "name": { "description": "Name of the classifier.", "minLength": 1, "type": "string" }, "sizeExceedingAction": { "description": "The size exceeded action.", "minimum": 0, "type": "integer" }, "zdpEnabled": { "description": "Enables Zero-Day Phishing (ZDP) protection for a classifier.", "type": "boolean" } }, "required": [ "name", "dynamicAnalysisEnabled", "enabled", "sizeExceedingAction", "zdpEnabled" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this policy.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "customHeaders": { "description": "Lists the policy custom header settings.", "items": { "additionalProperties": false, "description": "Lists the policy custom header object properties.", "properties": { "customHeaderId": { "description": "__Read-only__ The custom header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "domains": { "description": "Lists the domains assigned the custom header.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "headerName": { "description": "Name of the custom header.", "minLength": 1, "type": "string" }, "headerValue": { "description": "Custom header value.", "minLength": 1, "type": "string" } }, "required": [ "customHeaderId", "domains", "headerName", "headerValue" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-custom-header.yaml" } }, "minItems": 0, "type": "array" }, "customRequestHeaders": { "additionalProperties": false, "description": "Lists the policy custom request header settings.", "properties": { "args": { "description": "Lists custom request header arguments.", "items": { "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ The custom request header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "target_domain": { "description": "The target domain for the custom request headers.", "minLength": 1, "type": "string" } }, "required": [ "args", "id", "target_domain" ], "type": "object" }, "description": { "description": "A description of the policy that you provide.", "minLength": 1, "type": "string" }, "dlpExceptions": { "additionalProperties": false, "description": "Lists the DLP exceptions for the policy.", "properties": { "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "groups", "users" ], "type": "object" }, "dlpSettings": { "description": "Data loss prevention (DLP) actions and details.", "items": { "additionalProperties": false, "properties": { "action": { "description": "Action ID for the data loss prevention (DLP) dictionary.", "minimum": 0, "type": "integer" }, "dictionaryId": { "description": "__Read-only__ A unique identifier for the DLP dictionary.", "minimum": 1, "readOnly": true, "type": "integer" }, "dictionaryName": { "description": "Name of the DLP dictionary.", "minLength": 1, "type": "string" }, "dictionarySource": { "description": "Name of the DLP dictionary source.", "minLength": 1, "type": "string" }, "patterns": { "description": "Data loss prevention (DLP) patterns to match.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "threshold": { "description": "The maximum number of DLP patterns to consider.", "minimum": 0, "type": "integer" } }, "required": [ "action", "dictionaryId", "dictionaryName", "dictionarySource", "patterns", "threshold" ], "type": "object" }, "minItems": 0, "type": "array" }, "fWaasSettings": { "description": "Lists firewall as a service settings.", "items": { "additionalProperties": false, "description": "Configures Firewall as service.", "properties": { "appIds": { "description": "Lists app IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "countryCodeInfo": { "description": "Lists country code info.", "items": { "additionalProperties": false, "description": "Specifies firewall as a service geolocation data.", "properties": { "alpha2Code": { "description": "The ISO 3166 two-letter code for the region.", "minLength": 1, "type": "string" }, "alpha3Code": { "description": "The ISO 3166 three-letter code for the region.", "minLength": 1, "type": "string" }, "countryName": { "description": "Name of the firewall service.", "minLength": 1, "type": "string" } }, "required": [ "countryName", "alpha2Code", "alpha3Code" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-geo-info.yaml" } }, "minItems": 0, "type": "array" }, "countryCodes": { "description": "Lists country codes.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "destinationIp": { "description": "Lists destination IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "enabled": { "description": "Enables the service.", "type": "boolean" }, "fWaaSId": { "description": "Unique identifier for the firewall as service.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the service.", "minLength": 1, "type": "string" }, "networkServiceIds": { "description": "Lists network service IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "networkServiceInfo": { "description": "Lists network service info details.", "items": { "additionalProperties": false, "description": "Contains firewall as a service information.", "properties": { "description": { "description": "Name of the firewall as a service.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ Unique identifier for the firewall service.", "minimum": 1, "readOnly": true, "type": "integer" }, "port": { "description": "The port used by the firewall service.", "minLength": 1, "type": "string" }, "protocol": { "description": "Indicates the protocol used by firewall service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "serviceName": { "description": "Name of the Firewall as a Service.", "minLength": 1, "type": "string" } }, "required": [ "description", "id", "serviceName", "port", "protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-info.yaml" } }, "minItems": 0, "type": "array" }, "nonWebAppInfo": { "description": "Lists non-web-app info.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "ports": { "description": "Lists ports.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "protocol": { "description": "Describes the protocol used by service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "rank": { "description": "Priority of the service.", "minimum": 0, "type": "integer" }, "responseId": { "description": "__Read-only__ ID of the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "sourceIp": { "description": "Lists source IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "type": { "description": "Specifies the service type, either `IP`, `APP`, `NETWORK_SERVICE`, `GEO`, or `DEFAULT`.", "enum": [ "IP", "APP", "NETWORK_SERVICE", "GEO", "DEFAULT" ], "type": "string" } }, "required": [ "name", "type", "fWaaSId", "rank", "enabled", "responseId", "sourceIp", "destinationIp", "ports", "protocol", "appIds", "countryCodes", "networkServiceIds", "networkServiceInfo", "countryCodeInfo", "nonWebAppInfo" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-settings.yaml" } }, "minItems": 0, "type": "array" }, "farmId": { "description": "__Read-only__ A unique identifier for policy's farm.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeSettings": { "description": "Lists the filetype settings for the policy.", "items": { "additionalProperties": false, "description": "Lists the file type setting parameters.", "properties": { "applyTo": { "description": "Lists policies to apply the file type settings to.", "minLength": 1, "type": "string" }, "fileTypeId": { "description": "__Read-only__ Identifies each file type.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeInfo": { "additionalProperties": false, "description": "Contains file type info properties.", "properties": { "category": { "description": "The file category.", "minLength": 1, "type": "string" }, "code": { "description": "The file's code.", "minLength": 1, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The file's default action ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the file.", "type": "boolean" }, "id": { "description": "__Read-only__ Lists the file ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The filename.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "category", "defaultActionId", "deprecated", "code" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-info.yaml" } }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "name": { "description": "Name of the file type.", "minLength": 1, "type": "string" }, "responseId": { "description": "__Read-only__ Lists the response ID for the file type setting.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Provides details about response.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseOverrides": { "description": "Contains the AVC response override details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "type": { "description": "Lists the file type.", "minLength": 1, "type": "string" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "type", "responseId", "fileTypeId", "users", "groups", "responseInfo", "responseOverrides", "fileTypeInfo", "applyTo" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-settings.yaml" } }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ A unique identifier for each policy. Use this value for a `policyId` parameter in subsequent operations.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpId": { "description": "__Read-only__ A unique identifier for the associated identity provider.", "minLength": 1, "readOnly": true, "type": "string" }, "ipaSettings": { "additionalProperties": false, "description": "Contains IPA settings.", "properties": { "blockOnUploadScanTimeout": { "description": "Blocks on upload scan timeout.", "type": "boolean" }, "blockUnscannableFiles": { "description": "Blocks unscannable files.", "type": "boolean" }, "enabled": { "description": "Enables IPA.", "type": "boolean" }, "randomCheck": { "description": "Enables random check for `ipaSettings`.", "type": "boolean" }, "zdp": { "description": "Enables Zero-Day Phishing (ZDP) protection.", "type": "boolean" } }, "required": [ "enabled", "randomCheck", "zdp" ], "type": "object" }, "modifiedBy": { "description": "Name of the user who most recently modified this policy.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the policy.", "minLength": 1, "type": "string" }, "originPorts": { "description": "Lists origin ports for a policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "originValidationFailActionId": { "description": "__Read-only__ A unique identifier for a validation fail action.", "minimum": 1, "readOnly": true, "type": "integer" }, "policyGeneralSettings": { "additionalProperties": false, "description": "Specifies the policy's general settings.", "properties": { "androidDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "aupMigrated": { "description": "Migrates acceptable use policy.", "type": "boolean" }, "avcEnabled": { "description": "Enables the AVC.", "type": "boolean" }, "blockBrokenTLS": { "description": "Blocks broken TLS traffic.", "type": "boolean" }, "bypassO365": { "description": "Bypasses Microsoft Office 365 traffic.", "type": "boolean" }, "chromeOSDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "classifyMigrated": { "description": "Migrates classify information.", "type": "boolean" }, "disableClient": { "description": "Disables the SIA client.", "type": "boolean" }, "disableInsecureCiphers": { "description": "Disables insecure ciphers.", "type": "boolean" }, "dotConfig": { "additionalProperties": false, "description": "Contains DNS over TLS configuration.", "properties": { "mode": { "description": "The DNS over TLS mode:\n- `ATTEMPT` always tries to use DOT and falls back to standard DNS when unavailable.\n- `REQUIRED` requires DOT and informs the client the device isn't protected.\n- `DISABLED` doesn't apply DOT to secure DNS traffic.", "enum": [ "ATTEMPT", "REQUIRED", "DISABLED" ], "type": "string" }, "port": { "description": "The assigned port for `dotConfig`.", "minimum": 0, "type": "integer" } }, "required": [ "mode", "port" ], "type": "object" }, "enableIPIntelligence": { "description": "Enables IP intelligence.", "type": "boolean" }, "etpClientMultiUserEnabled": { "description": "Enables multi-user on the SIA client.", "type": "boolean" }, "fwaasEnabled": { "description": "Enables Firewall as a Service.", "type": "boolean" }, "httpProxyOverride": { "description": "Represents HTTP proxy override priority.", "minimum": 0, "type": "integer" }, "iOSDefaultAction": { "description": "Specifies the default action on iOS devices.", "minimum": 0, "type": "integer" }, "idpUserInfoRetryInterval": { "description": "Specifies the retry interval value for IDP users.", "minimum": 0, "type": "integer" }, "ignoreLocalDNSResolvers": { "description": "Ignores local DNS resolution.", "type": "boolean" }, "localBreakoutForBypass": { "description": "Enables local breakout for bypass.", "type": "boolean" }, "proxyAuthEnabled": { "description": "Enables proxy authentication.", "type": "boolean" }, "wgExceptions": { "description": "Enables walled-garden exceptions.", "type": "boolean" } }, "type": "object" }, "proxyHostname": { "description": "Name of proxy host machine.", "type": "string" }, "riskyFileHandlingSettings": { "additionalProperties": false, "description": "Describes file handling settings.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis.", "type": "boolean" }, "hugeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for huge risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "largeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for large risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "hugeRiskyFileResponse", "largeRiskyFileResponse" ], "type": "object" }, "safeSearchSettings": { "additionalProperties": false, "description": "Contains safe search settings.", "properties": { "youtube": { "description": "Specifies the Youtube access policy, either `open`, `moderate`, or `strict`.", "enum": [ "open", "moderate", "strict" ], "type": "string" } }, "required": [ "youtube" ], "type": "object" }, "securitySettings": { "description": "Contains the policy security settings.", "items": { "additionalProperties": false, "description": "Contains the policy security settings.", "properties": { "confirmedGroups": { "description": "Confirmed groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "confirmedResponseId": { "description": "A unique identifier for the confirmed response.", "minimum": 1, "type": "integer" }, "confirmedResponseInfo": { "additionalProperties": false, "description": "Contains data about the confirmed response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the confirmed response info.", "minimum": 0, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the confirmed response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "confirmedUsers": { "description": "Confirmed users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "listId": { "description": "A unique identifier for the list.", "minimum": 1, "type": "integer" }, "listInfo": { "additionalProperties": false, "description": "List information.", "properties": { "categoryId": { "description": "The unique category ID.", "minimum": 1, "type": "integer" }, "id": { "description": "A unique identifier for the list info.", "minimum": 0, "type": "integer" }, "listType": { "description": "The list type. See [List types](https://techdocs.akamai.com/etp-config/reference/list-types) for details.", "enum": [ "AKAMAI", "TOP_LEVEL_DOMAIN", "WHITELIST", "FILEHASHLIST", "FILEHASH_BLOCK", "DOMAIN_IP_LIST", "URL_BLOCK", "URL_BYPASS" ], "type": "string" }, "name": { "description": "The name of the list info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "categoryId" ], "type": "object" }, "responseOverridesConfirmed": { "description": "Response overrides for confirmed response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "responseOverridesSuspected": { "description": "Response overrides for suspected response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "shouldNotifyConfirmed": { "description": "Send alert on confirmed list hit.", "type": "boolean" }, "shouldNotifySuspected": { "description": "Send alert on suspected list hit.", "type": "boolean" }, "suspectedGroups": { "description": "Suspected groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "suspectedResponseId": { "description": "A unique identifier for the suspected response.", "minimum": 1, "type": "integer" }, "suspectedResponseInfo": { "additionalProperties": false, "description": "Suspected response data.", "properties": { "id": { "description": "A unique identifier for the suspected response info.", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the suspected response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "suspectedUsers": { "description": "Suspected users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "listId", "confirmedResponseId", "shouldNotifyConfirmed", "shouldNotifySuspected" ], "type": "object", "x-akamai": { "file-path": "schemas/security-settings-info.yaml" } }, "minItems": 0, "type": "array" }, "sites": { "description": "Contains associated site IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "sitesInfo": { "description": "Contains data about associated sites.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the site.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the site.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "sublocationInfo": { "description": "Lists sublocation info.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id-name.yaml" } }, "minItems": 0, "type": "array" }, "sublocations": { "description": "Lists the sublocations configured for this policy.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "trafficLogging": { "additionalProperties": false, "description": "Provides details of traffic logging in different modes.", "properties": { "headers": { "additionalProperties": false, "description": "Contains header information for traffic.", "properties": { "request": { "additionalProperties": false, "description": "The request details in the header.", "properties": { "mode": { "description": "Request mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" }, "response": { "additionalProperties": false, "description": "The response details in the header.", "properties": { "mode": { "description": "Response mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" } }, "required": [ "request", "response" ], "type": "object" }, "mode": { "description": "The traffic logging mode. Either `full`, `url`, `path`, or `host`.", "enum": [ "full", "url", "path", "host" ], "type": "string" }, "url": { "additionalProperties": false, "description": "URL details of the traffic.", "properties": { "mode": { "description": "The URL mode used for traffic logging. Either `FULL`, `PATH`, or `HOST`.", "enum": [ "FULL", "PATH", "HOST" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } }, "required": [ "headers", "mode", "url" ], "type": "object" } }, "required": [ "description", "name", "aupSettings", "securitySettings" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-retrieve-specific.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Update a policy", "tags": [ "Policies" ] }, "delete": { "description": "Deletes the specified policy.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/delete-policy" }, "operationId": "delete-policy", "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": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Remove a policy", "tags": [ "Policies" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } }, { "description": "A unique identifier for the policy.", "in": "path", "name": "policyId", "required": true, "schema": { "example": 5001, "type": "integer" }, "x-akamai": { "file-path": "parameters/policy-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/policy.yaml", "path-info": "/configs/{configId}/policies/{policyId}" } }, "/configs/{configId}/policy-metadata": { "get": { "description": "Returns the policy metadata details.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-policy-metadata" }, "operationId": "get-policy-metadata", "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": { "applications": [ { "categoryInfo": { "avcVendorCode": "5", "code": "", "defaultActionId": 5, "deprecated": false, "id": 119, "name": "IT Services", "riskId": 2, "subCategories": [] }, "deprecated": false, "description": "MobileIron is a mobile device management (MDM) system that provides ITS with a means of governing mobile access to WCM resources, including email, calendar, contacts, and other central applications.", "domainBasedApp": true, "groups": [], "id": 501, "name": "Mobileiron", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "risk": { "description": "Indicates the application has the lowest amount of risk for data loss or a security breach. These applications allow users to perform low-risk actions such as viewing content, listening to music, downloading files, and more.", "groups": [], "id": 1, "name": "Low", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, "users": [] }, { "categoryInfo": { "avcVendorCode": "9", "code": "BACKUP", "defaultActionId": 5, "deprecated": false, "id": 20, "name": "File Sharing", "riskId": 4, "subCategories": [], "vendorCode": "47" }, "deprecated": false, "description": "ZipShare is a web application that users can upload, share files which the files are zipped using WinZip's legendary compression, making them faster to download and saving bandwidth.", "domainBasedApp": false, "groups": [], "id": 560, "name": "ZipShare", "operationSettings": [ { "deprecated": false, "description": "Uploading files to web applications. This also includes inserting local files into content being edited online. Actions that correspond to 'File Transfer' and 'Sharing' are not included.", "groups": [], "id": 1, "name": "Uploading", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "deprecated": false, "description": "Sharing files with other users via web applications. This also includes generating share links and publishing files. Sharing public content, like SNS posts and news articles, is not included.", "groups": [], "id": 4, "name": "Sharing", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "deprecated": false, "description": "Logging into a service and authenticating users within the service.", "groups": [], "id": 15, "name": "Login/Authentication", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "deprecated": false, "description": "Making financial transactions such as buying, selling, paying, and remittance.", "groups": [], "id": 18, "name": "Paying And Transfering Money", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] } ], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "risk": { "description": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.", "groups": [], "id": 4, "name": "Very High", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, "users": [] }, { "categoryInfo": { "avcVendorCode": "21", "code": "PFINA", "defaultActionId": 5, "deprecated": false, "id": 23, "name": "Finance & Investing", "riskId": 3, "subCategories": [], "vendorCode": "3" }, "deprecated": false, "description": "Cloud9 is a voice conversation platform for traders that allows one-click recording and voice analysis of phone contents. It is provided by Cloud9 Technologies.", "domainBasedApp": true, "groups": [], "id": 334, "name": "Cloud9", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "risk": { "description": "Indicates the application is slightly at risk for data loss or a security breach. These applications allow users to perform slightly risky actions such as voting, rate scoring, text searches, translation, and more.", "groups": [], "id": 2, "name": "Medium", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, "users": [] } ], "categories": [ { "categoryInfo": { "avcVendorCode": "10", "code": "CHAT", "defaultActionId": 5, "deprecated": false, "id": 31, "name": "Chat Site", "riskId": 4, "subCategories": [], "vendorCode": "66" }, "description": "Websites that enable users to chat in real time through chat rooms, online conferences, video chat, or instant messaging.", "groups": [], "id": 31, "name": "Chat Site", "operationSettings": [ { "deprecated": false, "description": "Uploading files to web applications. This also includes inserting local files into content being edited online. Actions that correspond to 'File Transfer' and 'Sharing' are not included.", "groups": [], "id": 1, "name": "Uploading", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "deprecated": false, "description": "Posting articles and comments.", "groups": [], "id": 3, "name": "Posting", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "deprecated": false, "description": "Editing or creating content/documents on web applications. Actions that correspond to 'Post' are not included.", "groups": [], "id": 5, "name": "Editing", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "deprecated": true, "description": "Searching for keywords.", "groups": [], "id": 14, "name": "Searching", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "deprecated": false, "description": "Logging into a service and authenticating users within the service.", "groups": [], "id": 15, "name": "Login/Authentication", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "deprecated": false, "description": "Downloading files from web applications. Actions such as exporting content or data are also included.", "groups": [], "id": 2, "name": "Downloading", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "deprecated": false, "description": "Making financial transactions such as buying, selling, paying, and remittance.", "groups": [], "id": 18, "name": "Paying And Transfering Money", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "deprecated": false, "description": "Text-based chatting on a web application.", "groups": [], "id": 7, "name": "Chatting", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "deprecated": false, "description": "Sending files to others. Messaging functions in messengers, SNS, and conference services are included. Other file transfer functions are included in 'Uploading'.", "groups": [], "id": 8, "name": "File Transfer", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "deprecated": false, "description": "Making video and voice calls. Primarily this includes messenger, groupware, and conference service functions. Actions that correspond to 'Broadcasting' are not included.", "groups": [], "id": 13, "name": "Calling", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "deprecated": false, "description": "Inviting individuals to use web applications and their functions.", "groups": [], "id": 19, "name": "Inviting", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "deprecated": false, "description": "Browsing content and files on web applications. This also includes multimedia playing actions that do not fall into 'Listening'.", "groups": [], "id": 6, "name": "Viewing Contents", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] } ], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "categoryInfo": { "code": "BLOG", "defaultActionId": 5, "deprecated": false, "id": 35, "name": "Blogging", "subCategories": [], "vendorCode": "22" }, "description": "Websites that are blogs or host and publish blogs. These websites contain regularly posted entries that share views, commentary, or personal content. Blogs often include photos and multimedia.", "groups": [], "id": 35, "name": "Blogging", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "categoryInfo": { "code": "GORE", "defaultActionId": 5, "deprecated": false, "id": 38, "name": "Gore", "subCategories": [], "vendorCode": "54" }, "description": "Websites that promote or feature excessive, graphic, or deliberate violence against humans or animals.", "groups": [], "id": 38, "name": "Gore", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] } ], "fileTypes": [ { "fileTypeCategory": "message", "groups": [], "id": 159, "name": "message/rfc822", "operationSettings": [], "responseId": 4, "responseInfo": { "id": 4, "name": "Block - Error Page" }, "responseOverrides": [], "type": "message/rfc822", "users": [] }, { "fileTypeCategory": "application", "groups": [], "id": 27, "name": "application/vnd.openxmlformats-officedocument.wordprocessingml.document (docx)", "operationSettings": [], "responseId": 4, "responseInfo": { "id": 4, "name": "Block - Error Page" }, "responseOverrides": [], "type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "users": [] }, { "fileTypeCategory": "application", "groups": [], "id": 28, "name": "application/vnd.rn-realmedia (.rm , .ra , .rma , .ram , .rv , .rmvb)", "operationSettings": [], "responseId": 4, "responseInfo": { "id": 4, "name": "Block - Error Page" }, "responseOverrides": [], "type": "application/vnd.rn-realmedia", "users": [] } ], "operations": [ { "description": "Connecting to other computers via web applications.", "groups": [], "id": 16, "name": "Remote Connecting", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "description": "Delivering live streaming from users. Actions that correspond to 'Calling' are not included.", "groups": [], "id": 17, "name": "Broadcasting", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] }, { "description": "Making financial transactions such as buying, selling, paying, and remittance.", "groups": [], "id": 18, "name": "Paying And Transfering Money", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] } ], "risks": [ { "description": "Indicates the application has the lowest amount of risk for data loss or a security breach. These applications allow users to perform low-risk actions such as viewing content, listening to music, downloading files, and more.", "groups": [], "id": 1, "name": "Low", "operationSettings": [], "responseId": 5, "responseInfo": { "id": 5, "name": "Allow" }, "responseOverrides": [], "users": [] } ] }, "schema": { "additionalProperties": false, "description": "Specifies policy metadata with details.", "properties": { "akamaiDefinedLists": { "description": "The Akamai-defined lists assigned to the policy.", "items": { "description": "Security list details.", "items": { "additionalProperties": false, "properties": { "allowedForDnsPolicy": { "description": "Lists allowed for DNS policy.", "type": "boolean" }, "createdBy": { "description": "Author of the list.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp of the list creation.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "A description for the security list.", "minLength": 1, "type": "string" }, "id": { "description": "A unique identifier for each security list. Use this value for `listId` in subsequent operations.", "minimum": 1, "type": "integer" }, "listType": { "description": "The list type. See [List types](https://techdocs.akamai.com/etp-config/reference/list-types) for details on each value.", "enum": [ "AKAMAI", "TOP_LEVEL_DOMAIN", "WHITELIST", "FILEHASHLIST", "FILEHASH_BLOCK", "DOMAIN_IP_LIST", "URL_BLOCK", "URL_BYPASS" ], "type": "string" }, "name": { "description": "The name of the list.", "minLength": 1, "type": "string" }, "securityCategoryId": { "description": "A unique identifier for the security category.", "minimum": 1, "type": "integer" }, "securityCategoryInfo": { "additionalProperties": false, "description": "Contains data about the security category.", "properties": { "id": { "description": "A unique identifier for the security category.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the security category.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "name", "description", "allowedForDnsPolicy", "createdBy", "createdDate", "id", "securityCategoryId", "securityCategoryInfo" ], "type": "object" }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/akamai-security-lists.yaml" } }, "minItems": 0, "type": "array" }, "applications": { "description": "Lists AVC applications.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "aupCategories": { "description": "Lists AUP categories.", "items": { "additionalProperties": false, "description": "Lists AUP categories with their details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "minItems": 0, "type": "array" }, "categories": { "description": "Lists AVC categories.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "dictionaries": { "description": "Lists dictionaries available.", "items": { "additionalProperties": false, "description": "Lists parameters in the DLP dictionary object.", "properties": { "aggressiveMode": { "description": "Enables aggressive mode.", "type": "boolean" }, "akamaiDefined": { "description": "Indicates an Akamai-defined dictionary.", "type": "boolean" }, "createdBy": { "description": "__Read-only__ Name of the user who created this dictionary.", "minLength": 1, "readOnly": true, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the dictionary's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "Description of the dictionary.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ The unique identifier for the data loss protection (DLP) dictionary.", "minimum": 1, "readOnly": true, "type": "integer" }, "modifiedBy": { "description": "__Read-only__ Name of the user who most recently modified the dictionary.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking when this dictionary's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the dictionary.", "minLength": 1, "type": "string" }, "patternDetails": { "description": "The pattern details.", "items": { "additionalProperties": false, "description": "Lists DLP pattern detail properties.", "properties": { "description": { "description": "A description of the DLP pattern.", "minLength": 1, "type": "string" }, "id": { "description": "A unique identifier for the data loss protection (DLP) pattern.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the DLP pattern.", "minLength": 1, "type": "string" } }, "required": [ "name", "description", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/dlp-pattern-details.yaml" } }, "minItems": 0, "type": "array" }, "patterns": { "description": "The pattern ID.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "policies": { "description": "Lists the security policy assigned to a site. Configure the accepted use policy and set responses for known and suspected threats under specified categories.", "items": { "additionalProperties": false, "description": "The security policy to assign to a site. Configure the accepted use policy and set responses for known and suspected threats under the specified categories.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Marks a policy as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated administrators for the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks a policy as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "akamaiDefined": { "description": "Marks a policy as Akamai-defined.", "type": "boolean" }, "aupSettings": { "description": "Contains the acceptable use policy settings.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AUP category data.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "groups": { "description": "Groups users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Describes the operation settings on the AUP setting.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Lists user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "categoryId" ], "type": "object" }, "minItems": 0, "type": "array" }, "aupSource": { "description": "Name of acceptable use policy source for the policy.", "minLength": 1, "type": "string" }, "authPolicy": { "additionalProperties": false, "description": "Details of the authorization policy adopted for the policy.", "properties": { "Oidc": { "additionalProperties": false, "description": "Provides OpenID Connect (OIDC) provider and client details.", "properties": { "client": { "additionalProperties": false, "description": "Provides information about a client.", "properties": { "authUri": { "description": "URL for authorization.", "type": "string" }, "checkSessionUri": { "description": "URL to check if session is alive.", "type": "string" }, "clientId": { "description": "__Read-only__ A unique identifier for the client.", "minimum": 1, "readOnly": true, "type": "integer" }, "clientName": { "description": "Name of the client.", "minLength": 1, "type": "string" }, "endSessionUri": { "description": "URL for ending session.", "type": "string" }, "frontChannelLogoutUrl": { "description": "URLs for logout from front channel.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "grantTypes": { "description": "Client grant types.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "idpId": { "description": "__Read-only__ A unique identifier for the IDP for the OIDC.", "minLength": 1, "readOnly": true, "type": "string" }, "javascriptOrigins": { "description": "JavaScript origin locations.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "postLogoutUris": { "description": "URIs for post logout from client.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "redirectUris": { "description": "URLs for redirection.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "tokenUri": { "description": "URL for token.", "type": "string" }, "userUri": { "description": "URL for user information.", "type": "string" } }, "required": [ "authUri", "checkSessionUri", "clientId", "clientName", "endSessionUri", "frontChannelLogoutUrl", "grantTypes", "idpId", "javascriptOrigins", "postLogoutUris", "redirectUris", "tokenUri", "userUri" ], "type": "object" }, "provider": { "additionalProperties": false, "description": "Mapping of authorization policy URLs to OpenID Connect (OIDC) URLs.", "properties": { "authPolicyUrl": { "description": "The URL from the authorization policy.", "type": "string" }, "oidcUrl": { "description": "The URL for the OpenID Connect (OIDC).", "type": "string" } }, "required": [ "authPolicyUrl", "oidcUrl" ], "type": "object" } }, "required": [ "client", "provider" ], "type": "object" }, "allowUnauthenticated": { "description": "Allows unauthenticated users.", "type": "boolean" }, "enabled": { "description": "Enables an authorization policy.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the authorization policy.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpPreAuthConsent": { "description": "Indicates IDP pre-authorization consent.", "type": "boolean" }, "retryAuthForUnauthenticatedSessions": { "description": "The number of retries for an unauthenticated session.", "minimum": 0, "type": "integer" }, "sessionTtl": { "description": "The duration of a session.", "minimum": 0, "type": "integer" }, "userInfoRefreshTime": { "description": "__Read-only__ ISO 8601 timestamp marking the last user authentication refresh.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "Oidc", "enabled", "id", "idpPreAuthConsent", "allowUnauthenticated", "retryAuthForUnauthenticatedSessions", "sessionTtl", "userInfoRefreshTime" ], "type": "object" }, "authenticationMode": { "description": "Specifies the authentication mode. Either `REQUIRED`, `OPTIONAL`, or `NONE`.", "enum": [ "REQUIRED", "OPTIONAL", "NONE" ], "type": "string" }, "avcSettings": { "additionalProperties": false, "description": "Contains the AVC setting properties.", "properties": { "applicationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "categorySettings": { "description": "Lists the AVC category setting properties.", "items": { "additionalProperties": false, "properties": { "categoryId": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "Contains data for a category.", "properties": { "code": { "description": "The acceptable use policy categorization code.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The selected default action for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the category.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the category.", "minLength": 1, "type": "string" } }, "required": [ "name", "code", "defaultActionId", "deprecated", "id" ], "type": "object" }, "description": { "description": "Description for the category settings.", "minLength": 1, "type": "string" }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "operationSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "Contains response data.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseId": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseOverrides": { "description": "Response overrides.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of a response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "description", "categoryId", "categoryInfo", "groups", "operationSettings", "response", "responseId", "responseOverrides", "users" ], "type": "object" }, "minItems": 0, "type": "array" }, "riskSettings": { "description": "Policy metadata with details.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "applicationSettings", "categorySettings", "riskSettings" ], "type": "object" }, "basicSettings": { "additionalProperties": false, "description": "Contains the basic policy settings.", "properties": { "dnssec": { "description": "When enabled, provides DNS security.", "type": "boolean" }, "edns0ecs": { "description": "When enabled, optimizes CDN traffic using the `EDNS-Client-Subnet` extension.", "type": "boolean" }, "forwardProxyEnabled": { "description": "Enables the forward proxy.", "type": "boolean" }, "proxyEnabled": { "description": "Enables the proxy.", "type": "boolean" }, "safesearch": { "description": "Enables the safe search feature.", "type": "boolean" }, "trustXFF": { "description": "Enables trust of `X-Forwarded-For` headers.", "type": "boolean" } }, "required": [ "dnssec", "edns0ecs" ], "type": "object" }, "classifiers": { "additionalProperties": false, "description": "Contains classifier details for a policy.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis for a classifier.", "type": "boolean" }, "enabled": { "description": "Enables the classifier.", "type": "boolean" }, "name": { "description": "Name of the classifier.", "minLength": 1, "type": "string" }, "sizeExceedingAction": { "description": "The size exceeded action.", "minimum": 0, "type": "integer" }, "zdpEnabled": { "description": "Enables Zero-Day Phishing (ZDP) protection for a classifier.", "type": "boolean" } }, "required": [ "name", "dynamicAnalysisEnabled", "enabled", "sizeExceedingAction", "zdpEnabled" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this policy.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "customHeaders": { "description": "Lists the policy custom header settings.", "items": { "additionalProperties": false, "description": "Lists the policy custom header object properties.", "properties": { "customHeaderId": { "description": "__Read-only__ The custom header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "domains": { "description": "Lists the domains assigned the custom header.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "headerName": { "description": "Name of the custom header.", "minLength": 1, "type": "string" }, "headerValue": { "description": "Custom header value.", "minLength": 1, "type": "string" } }, "required": [ "customHeaderId", "domains", "headerName", "headerValue" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-custom-header.yaml" } }, "minItems": 0, "type": "array" }, "customRequestHeaders": { "additionalProperties": false, "description": "Lists the policy custom request header settings.", "properties": { "args": { "description": "Lists custom request header arguments.", "items": { "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ The custom request header ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "target_domain": { "description": "The target domain for the custom request headers.", "minLength": 1, "type": "string" } }, "required": [ "args", "id", "target_domain" ], "type": "object" }, "description": { "description": "A description of the policy that you provide.", "minLength": 1, "type": "string" }, "dlpExceptions": { "additionalProperties": false, "description": "Lists the DLP exceptions for the policy.", "properties": { "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "groups", "users" ], "type": "object" }, "dlpSettings": { "description": "Data loss prevention (DLP) actions and details.", "items": { "additionalProperties": false, "properties": { "action": { "description": "Action ID for the data loss prevention (DLP) dictionary.", "minimum": 0, "type": "integer" }, "dictionaryId": { "description": "__Read-only__ A unique identifier for the DLP dictionary.", "minimum": 1, "readOnly": true, "type": "integer" }, "dictionaryName": { "description": "Name of the DLP dictionary.", "minLength": 1, "type": "string" }, "dictionarySource": { "description": "Name of the DLP dictionary source.", "minLength": 1, "type": "string" }, "patterns": { "description": "Data loss prevention (DLP) patterns to match.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "threshold": { "description": "The maximum number of DLP patterns to consider.", "minimum": 0, "type": "integer" } }, "required": [ "action", "dictionaryId", "dictionaryName", "dictionarySource", "patterns", "threshold" ], "type": "object" }, "minItems": 0, "type": "array" }, "fWaasSettings": { "description": "Lists firewall as a service settings.", "items": { "additionalProperties": false, "description": "Configures Firewall as service.", "properties": { "appIds": { "description": "Lists app IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "countryCodeInfo": { "description": "Lists country code info.", "items": { "additionalProperties": false, "description": "Specifies firewall as a service geolocation data.", "properties": { "alpha2Code": { "description": "The ISO 3166 two-letter code for the region.", "minLength": 1, "type": "string" }, "alpha3Code": { "description": "The ISO 3166 three-letter code for the region.", "minLength": 1, "type": "string" }, "countryName": { "description": "Name of the firewall service.", "minLength": 1, "type": "string" } }, "required": [ "countryName", "alpha2Code", "alpha3Code" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-geo-info.yaml" } }, "minItems": 0, "type": "array" }, "countryCodes": { "description": "Lists country codes.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "destinationIp": { "description": "Lists destination IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "enabled": { "description": "Enables the service.", "type": "boolean" }, "fWaaSId": { "description": "Unique identifier for the firewall as service.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the service.", "minLength": 1, "type": "string" }, "networkServiceIds": { "description": "Lists network service IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "networkServiceInfo": { "description": "Lists network service info details.", "items": { "additionalProperties": false, "description": "Contains firewall as a service information.", "properties": { "description": { "description": "Name of the firewall as a service.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ Unique identifier for the firewall service.", "minimum": 1, "readOnly": true, "type": "integer" }, "port": { "description": "The port used by the firewall service.", "minLength": 1, "type": "string" }, "protocol": { "description": "Indicates the protocol used by firewall service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "serviceName": { "description": "Name of the Firewall as a Service.", "minLength": 1, "type": "string" } }, "required": [ "description", "id", "serviceName", "port", "protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-info.yaml" } }, "minItems": 0, "type": "array" }, "nonWebAppInfo": { "description": "Lists non-web-app info.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "ports": { "description": "Lists ports.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "protocol": { "description": "Describes the protocol used by service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "rank": { "description": "Priority of the service.", "minimum": 0, "type": "integer" }, "responseId": { "description": "__Read-only__ ID of the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "sourceIp": { "description": "Lists source IPs.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "type": { "description": "Specifies the service type, either `IP`, `APP`, `NETWORK_SERVICE`, `GEO`, or `DEFAULT`.", "enum": [ "IP", "APP", "NETWORK_SERVICE", "GEO", "DEFAULT" ], "type": "string" } }, "required": [ "name", "type", "fWaaSId", "rank", "enabled", "responseId", "sourceIp", "destinationIp", "ports", "protocol", "appIds", "countryCodes", "networkServiceIds", "networkServiceInfo", "countryCodeInfo", "nonWebAppInfo" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-settings.yaml" } }, "minItems": 0, "type": "array" }, "farmId": { "description": "__Read-only__ A unique identifier for policy's farm.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeSettings": { "description": "Lists the filetype settings for the policy.", "items": { "additionalProperties": false, "description": "Lists the file type setting parameters.", "properties": { "applyTo": { "description": "Lists policies to apply the file type settings to.", "minLength": 1, "type": "string" }, "fileTypeId": { "description": "__Read-only__ Identifies each file type.", "minimum": 1, "readOnly": true, "type": "integer" }, "fileTypeInfo": { "additionalProperties": false, "description": "Contains file type info properties.", "properties": { "category": { "description": "The file category.", "minLength": 1, "type": "string" }, "code": { "description": "The file's code.", "minLength": 1, "type": "string" }, "defaultActionId": { "description": "__Read-only__ The file's default action ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the file.", "type": "boolean" }, "id": { "description": "__Read-only__ Lists the file ID.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The filename.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "category", "defaultActionId", "deprecated", "code" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-info.yaml" } }, "groups": { "description": "Groups that users belong to.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "name": { "description": "Name of the file type.", "minLength": 1, "type": "string" }, "responseId": { "description": "__Read-only__ Lists the response ID for the file type setting.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Provides details about response.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseOverrides": { "description": "Contains the AVC response override details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "type": { "description": "Lists the file type.", "minLength": 1, "type": "string" }, "users": { "description": "Specifies user emails assigned to the policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "type", "responseId", "fileTypeId", "users", "groups", "responseInfo", "responseOverrides", "fileTypeInfo", "applyTo" ], "type": "object", "x-akamai": { "file-path": "schemas/file-type-settings.yaml" } }, "minItems": 0, "type": "array" }, "id": { "description": "__Read-only__ A unique identifier for each policy. Use this value for a `policyId` parameter in subsequent operations.", "minimum": 1, "readOnly": true, "type": "integer" }, "idpId": { "description": "__Read-only__ A unique identifier for the associated identity provider.", "minLength": 1, "readOnly": true, "type": "string" }, "ipaSettings": { "additionalProperties": false, "description": "Contains IPA settings.", "properties": { "blockOnUploadScanTimeout": { "description": "Blocks on upload scan timeout.", "type": "boolean" }, "blockUnscannableFiles": { "description": "Blocks unscannable files.", "type": "boolean" }, "enabled": { "description": "Enables IPA.", "type": "boolean" }, "randomCheck": { "description": "Enables random check for `ipaSettings`.", "type": "boolean" }, "zdp": { "description": "Enables Zero-Day Phishing (ZDP) protection.", "type": "boolean" } }, "required": [ "enabled", "randomCheck", "zdp" ], "type": "object" }, "modifiedBy": { "description": "Name of the user who most recently modified this policy.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this policy's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the policy.", "minLength": 1, "type": "string" }, "originPorts": { "description": "Lists origin ports for a policy.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "originValidationFailActionId": { "description": "__Read-only__ A unique identifier for a validation fail action.", "minimum": 1, "readOnly": true, "type": "integer" }, "policyGeneralSettings": { "additionalProperties": false, "description": "Specifies the policy's general settings.", "properties": { "androidDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "aupMigrated": { "description": "Migrates acceptable use policy.", "type": "boolean" }, "avcEnabled": { "description": "Enables the AVC.", "type": "boolean" }, "blockBrokenTLS": { "description": "Blocks broken TLS traffic.", "type": "boolean" }, "bypassO365": { "description": "Bypasses Microsoft Office 365 traffic.", "type": "boolean" }, "chromeOSDefaultAction": { "description": "Specifies the default action on Android devices.", "minimum": 0, "type": "integer" }, "classifyMigrated": { "description": "Migrates classify information.", "type": "boolean" }, "disableClient": { "description": "Disables the SIA client.", "type": "boolean" }, "disableInsecureCiphers": { "description": "Disables insecure ciphers.", "type": "boolean" }, "dotConfig": { "additionalProperties": false, "description": "Contains DNS over TLS configuration.", "properties": { "mode": { "description": "The DNS over TLS mode:\n- `ATTEMPT` always tries to use DOT and falls back to standard DNS when unavailable.\n- `REQUIRED` requires DOT and informs the client the device isn't protected.\n- `DISABLED` doesn't apply DOT to secure DNS traffic.", "enum": [ "ATTEMPT", "REQUIRED", "DISABLED" ], "type": "string" }, "port": { "description": "The assigned port for `dotConfig`.", "minimum": 0, "type": "integer" } }, "required": [ "mode", "port" ], "type": "object" }, "enableIPIntelligence": { "description": "Enables IP intelligence.", "type": "boolean" }, "etpClientMultiUserEnabled": { "description": "Enables multi-user on the SIA client.", "type": "boolean" }, "fwaasEnabled": { "description": "Enables Firewall as a Service.", "type": "boolean" }, "httpProxyOverride": { "description": "Represents HTTP proxy override priority.", "minimum": 0, "type": "integer" }, "iOSDefaultAction": { "description": "Specifies the default action on iOS devices.", "minimum": 0, "type": "integer" }, "idpUserInfoRetryInterval": { "description": "Specifies the retry interval value for IDP users.", "minimum": 0, "type": "integer" }, "ignoreLocalDNSResolvers": { "description": "Ignores local DNS resolution.", "type": "boolean" }, "localBreakoutForBypass": { "description": "Enables local breakout for bypass.", "type": "boolean" }, "proxyAuthEnabled": { "description": "Enables proxy authentication.", "type": "boolean" }, "wgExceptions": { "description": "Enables walled-garden exceptions.", "type": "boolean" } }, "type": "object" }, "proxyHostname": { "description": "Name of proxy host machine.", "type": "string" }, "riskyFileHandlingSettings": { "additionalProperties": false, "description": "Describes file handling settings.", "properties": { "dynamicAnalysisEnabled": { "description": "Enables dynamic analysis.", "type": "boolean" }, "hugeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for huge risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "largeRiskyFileResponse": { "additionalProperties": false, "description": "Specifies the file response for large risky files.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "hugeRiskyFileResponse", "largeRiskyFileResponse" ], "type": "object" }, "safeSearchSettings": { "additionalProperties": false, "description": "Contains safe search settings.", "properties": { "youtube": { "description": "Specifies the Youtube access policy, either `open`, `moderate`, or `strict`.", "enum": [ "open", "moderate", "strict" ], "type": "string" } }, "required": [ "youtube" ], "type": "object" }, "securitySettings": { "description": "Contains the policy security settings.", "items": { "additionalProperties": false, "description": "Contains the policy security settings.", "properties": { "confirmedGroups": { "description": "Confirmed groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "confirmedResponseId": { "description": "A unique identifier for the confirmed response.", "minimum": 1, "type": "integer" }, "confirmedResponseInfo": { "additionalProperties": false, "description": "Contains data about the confirmed response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the confirmed response info.", "minimum": 0, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the confirmed response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "confirmedUsers": { "description": "Confirmed users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "listId": { "description": "A unique identifier for the list.", "minimum": 1, "type": "integer" }, "listInfo": { "additionalProperties": false, "description": "List information.", "properties": { "categoryId": { "description": "The unique category ID.", "minimum": 1, "type": "integer" }, "id": { "description": "A unique identifier for the list info.", "minimum": 0, "type": "integer" }, "listType": { "description": "The list type. See [List types](https://techdocs.akamai.com/etp-config/reference/list-types) for details.", "enum": [ "AKAMAI", "TOP_LEVEL_DOMAIN", "WHITELIST", "FILEHASHLIST", "FILEHASH_BLOCK", "DOMAIN_IP_LIST", "URL_BLOCK", "URL_BYPASS" ], "type": "string" }, "name": { "description": "The name of the list info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "categoryId" ], "type": "object" }, "responseOverridesConfirmed": { "description": "Response overrides for confirmed response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "responseOverridesSuspected": { "description": "Response overrides for suspected response.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "shouldNotifyConfirmed": { "description": "Send alert on confirmed list hit.", "type": "boolean" }, "shouldNotifySuspected": { "description": "Send alert on suspected list hit.", "type": "boolean" }, "suspectedGroups": { "description": "Suspected groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "suspectedResponseId": { "description": "A unique identifier for the suspected response.", "minimum": 1, "type": "integer" }, "suspectedResponseInfo": { "additionalProperties": false, "description": "Suspected response data.", "properties": { "id": { "description": "A unique identifier for the suspected response info.", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the suspected response info.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "suspectedUsers": { "description": "Suspected users.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "listId", "confirmedResponseId", "shouldNotifyConfirmed", "shouldNotifySuspected" ], "type": "object", "x-akamai": { "file-path": "schemas/security-settings-info.yaml" } }, "minItems": 0, "type": "array" }, "sites": { "description": "Contains associated site IDs.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "sitesInfo": { "description": "Contains data about associated sites.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for the site.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the site.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" }, "sublocationInfo": { "description": "Lists sublocation info.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id-name.yaml" } }, "minItems": 0, "type": "array" }, "sublocations": { "description": "Lists the sublocations configured for this policy.", "items": { "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "trafficLogging": { "additionalProperties": false, "description": "Provides details of traffic logging in different modes.", "properties": { "headers": { "additionalProperties": false, "description": "Contains header information for traffic.", "properties": { "request": { "additionalProperties": false, "description": "The request details in the header.", "properties": { "mode": { "description": "Request mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" }, "response": { "additionalProperties": false, "description": "The response details in the header.", "properties": { "mode": { "description": "Response mode in headers. Either `FULL`, `FILTER`, or `CLEAR`.", "enum": [ "FULL", "FILTER", "CLEAR" ], "type": "string" }, "whiteList": { "description": "Lists allowed header values.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "mode", "whiteList" ], "type": "object" } }, "required": [ "request", "response" ], "type": "object" }, "mode": { "description": "The traffic logging mode. Either `full`, `url`, `path`, or `host`.", "enum": [ "full", "url", "path", "host" ], "type": "string" }, "url": { "additionalProperties": false, "description": "URL details of the traffic.", "properties": { "mode": { "description": "The URL mode used for traffic logging. Either `FULL`, `PATH`, or `HOST`.", "enum": [ "FULL", "PATH", "HOST" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } }, "required": [ "headers", "mode", "url" ], "type": "object" } }, "required": [ "description", "name", "aupSettings", "securitySettings" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-retrieve-specific.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "name", "id", "akamaiDefined", "createdBy", "createdDate", "aggressiveMode", "patternDetails", "patterns" ], "type": "object", "x-akamai": { "file-path": "schemas/dlp-dictionary.yaml" } }, "minItems": 0, "type": "array" }, "fWaaSApps": { "description": "Lists Firewall as Service Apps assigned to the policy.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "fWaaSNetworkServices": { "description": "Lists firewalls-as-a-service assigned to the policy.", "items": { "additionalProperties": false, "description": "Contains firewall as a service information.", "properties": { "description": { "description": "Name of the firewall as a service.", "minLength": 1, "type": "string" }, "id": { "description": "__Read-only__ Unique identifier for the firewall service.", "minimum": 1, "readOnly": true, "type": "integer" }, "port": { "description": "The port used by the firewall service.", "minLength": 1, "type": "string" }, "protocol": { "description": "Indicates the protocol used by firewall service, either `tcp`, `udp`, or `both`.", "enum": [ "tcp", "udp", "both" ], "type": "string" }, "serviceName": { "description": "Name of the Firewall as a Service.", "minLength": 1, "type": "string" } }, "required": [ "description", "id", "serviceName", "port", "protocol" ], "type": "object", "x-akamai": { "file-path": "schemas/fwass-info.yaml" } }, "minItems": 0, "type": "array" }, "fileTypes": { "description": "Lists AVC file types.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "honeypots": { "description": "Lists custom responses.", "items": { "additionalProperties": false, "description": "Contains resource ID-Name information.", "properties": { "id": { "description": "__Read-only__ Unique identifier for the resource.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-id-name.yaml" } }, "minItems": 1, "type": "array" }, "httpProxyOverride": { "description": "Enables HTTP proxy override.", "minimum": 0, "type": "integer" }, "metadataFwaaS": { "description": "Contains firewall-as-a-service metadata.", "minLength": 1, "type": "string" }, "operations": { "description": "Lists AVC operations.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "proxyCredentialExists": { "description": "Indicates the presence of proxy credentials for the account.", "type": "boolean" }, "responses": { "description": "Lists responses.", "items": { "description": "Built-in responses.", "items": { "additionalProperties": false, "properties": { "allowedForAup": { "description": "Allows AUP responses.", "type": "boolean" }, "allowedForDnsPolicy": { "description": "Allows DNS policy responses.", "type": "boolean" }, "allowedForSecurity": { "description": "Allows Security Connector responses.", "type": "boolean" }, "description": { "description": "Description of the built-in response.", "minLength": 1, "type": "string" }, "id": { "description": "A unique identifier for each response. Use this value for any `responseId` parameters in subsequent operations.", "type": "integer" }, "name": { "description": "Name of the built-in response.", "minLength": 1, "type": "string" } }, "required": [ "name", "description", "allowedForAup", "allowedForDnsPolicy", "allowedForSecurity", "id" ], "type": "object" }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/akamai-responses.yaml" } }, "minItems": 1, "type": "array" }, "risks": { "description": "Lists AVC risks.", "items": { "additionalProperties": false, "description": "Policy AVC metadata with details.", "properties": { "applicationCount": { "description": "The AVC application count.", "minimum": 0, "type": "integer" }, "categoryId": { "description": "__Read-only__ Unique identifier for the AVC category.", "minimum": 1, "readOnly": true, "type": "integer" }, "categoryInfo": { "additionalProperties": false, "description": "AVC category details.", "properties": { "avcVendorCode": { "description": "The vendor code for the AVC entity.", "minLength": 1, "type": "string" }, "code": { "description": "The unique code for the AUP.", "minLength": 0, "type": "string" }, "defaultActionId": { "description": "__Read-only__ Action ID on the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "deprecated": { "description": "Deprecates the AUP.", "type": "boolean" }, "id": { "description": "__Read-only__ A unique identifier for the category.", "minimum": 1, "readOnly": true, "type": "integer" }, "isDeployable": { "description": "Indicates if the AVC entity is deployable.", "type": "boolean" }, "name": { "description": "Name of the response.", "minLength": 1, "type": "string" }, "riskId": { "description": "__Read-only__ Identifies the risk level for the AUP category.", "minimum": 1, "readOnly": true, "type": "integer" }, "subCategories": { "description": "A nested AUP object type.", "items": { "description": "A nested AUP category object.", "type": "object", "x-akamai": { "file-path": "schemas/aup-categories-nested.yaml" } }, "minItems": 0, "type": "array" }, "vendorCode": { "description": "Unique identifier of the vendor.", "minLength": 1, "type": "string" } }, "required": [ "name", "id", "defaultActionId", "code", "deprecated" ], "type": "object", "x-akamai": { "file-path": "schemas/aup-categories.yaml" } }, "deprecated": { "description": "Deprecates the AVC entity.", "type": "boolean" }, "description": { "description": "Describes the AVC entity.", "minLength": 1, "type": "string" }, "devicePostureRiskTiers": { "description": "The selected device posture risk tiers.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "domainBasedApp": { "description": "Specifies a domain-based AVC entity.", "type": "boolean" }, "fileTypeCategory": { "description": "The filetype category based on MIME type. Either `message`, `application`, `audio`, `video`, `image`, `text`, `model`, or `x-epoc`.\nUse `x-epoc` for Symbian Series 3 install packages.", "enum": [ "message", "application", "audio", "video", "image", "text", "model", "x-epoc" ], "minLength": 1, "type": "string" }, "groups": { "description": "User groups for the AVC categories.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier for the AVC entity.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the AVC entity.", "minLength": 1, "type": "string" }, "operationSettings": { "description": "AVC operation settings with details.", "items": { "description": "A nested AVC type object.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "minItems": 0, "type": "array" }, "response": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "responseId": { "description": "__Read-only__ Response ID of the AVC entity.", "minimum": 1, "readOnly": true, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "Contains data for the response.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the response.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the response.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "responseOverrides": { "description": "AUP response overrides with details.", "items": { "additionalProperties": false, "description": "AVC response override with details.", "properties": { "groupIds": { "description": "AVC category user groups.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "responseId": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "responseInfo": { "additionalProperties": false, "description": "AVC response details.", "properties": { "id": { "description": "Unique identifier for the response.", "minimum": 1, "type": "integer" }, "name": { "description": "Name of the response entity.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/response-info.yaml" } }, "userIds": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "responseId", "responseInfo", "userIds", "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/response-override.yaml" } }, "minItems": 0, "type": "array" }, "risk": { "description": "AVC risk details.", "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info-nested.yaml" } }, "type": { "description": "The file type.", "minLength": 1, "type": "string" }, "users": { "description": "AVC users for the AVC entity.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "vendorAppId": { "description": "Unique identifier for the vendor app.", "minimum": 1, "type": "integer" } }, "required": [ "name", "id", "responseId", "users", "groups", "responseOverrides", "operationSettings" ], "type": "object", "x-akamai": { "file-path": "schemas/avc-type-info.yaml" } }, "minItems": 0, "type": "array" }, "sinkholes": { "description": "Sinkhole detail objects.", "items": { "additionalProperties": false, "description": "Contains resource information.", "properties": { "id": { "description": "Unique identifier for the resource.", "type": "integer" }, "name": { "description": "Name of the resource.", "minLength": 1, "type": "string" }, "type": { "description": "Specifies resource type.", "minLength": 1, "type": "string" }, "version": { "description": "Specifies the resource version.", "minLength": 1, "type": "string" } }, "required": [ "name", "type", "version", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-type.yaml" } }, "minItems": 1, "type": "array" } }, "required": [ "risks", "applications", "categories", "operations", "fileTypes" ], "type": "object", "x-akamai": { "file-path": "schemas/policy-metadata.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get policy metadata", "tags": [ "Policies" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/policy-metadata.yaml", "path-info": "/configs/{configId}/policy-metadata" } }, "/configs/{configId}/proxy-credentials": { "post": { "description": "Creates a new proxy credential.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-proxy-credential" }, "operationId": "post-proxy-credential", "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": { "password": "QWthbWFpMTIzIQ==", "username": "jkowalski" }, "schema": { "additionalProperties": false, "description": "Lists the proxy credential creation properties.", "properties": { "password": { "description": "The password encoded in Base64 format.", "format": "byte", "type": "string" }, "username": { "description": "Name of proxy credential user.", "minLength": 1, "type": "string" } }, "required": [ "password", "username" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-credential-create.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Create a proxy credential", "tags": [ "Proxy credentials" ] }, "get": { "description": "Provides list of proxy credentials.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-proxy-credentials" }, "operationId": "get-proxy-credentials", "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": [ { "createdBy": "jperez", "createdDate": "2020-05-18T15:40:07.146+0000", "modifiedBy": "tyamada", "modifiedDate": "2020-07-22T18:49:06.031+0000", "username": "szhang@1041" }, { "createdBy": "hgildong", "createdDate": "2020-05-18T15:40:07.146+0000", "modifiedBy": "jperez", "modifiedDate": "2020-07-22T18:49:06.031+0000", "username": "mrossi@1041" }, { "createdBy": "jsmith", "createdDate": "2020-05-18T15:40:07.146+0000", "modifiedBy": "mrossi", "modifiedDate": "2020-07-22T18:49:06.031+0000", "username": "jperez@1041" }, { "createdBy": "szhang", "createdDate": "2020-05-18T15:40:07.146+0000", "modifiedBy": "jkowalski", "modifiedDate": "2020-07-22T18:49:06.031+0000", "username": "tyamada@1041" }, { "createdBy": "alfulani", "createdDate": "2020-05-18T15:40:07.146+0000", "modifiedBy": "alfulani", "modifiedDate": "2020-07-22T18:49:06.031+0000", "username": "alfulani@1041" }, { "createdBy": "tyamada", "createdDate": "2020-05-18T15:40:07.146+0000", "modifiedBy": "tyamada", "modifiedDate": "2020-07-22T18:49:06.031+0000", "username": "afero@1041" }, { "createdBy": "jkowalski", "createdDate": "2020-05-18T15:40:07.146+0000", "modifiedBy": "mrossi", "modifiedDate": "2020-07-22T18:49:06.031+0000", "username": "mrossi@1041" } ], "schema": { "description": "All existing proxy credentials.", "items": { "additionalProperties": false, "description": "Lists the properties of the requested proxy credentials.", "properties": { "createdBy": { "description": "Name of the user who created this proxy credential.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this proxy credential's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "modifiedBy": { "description": "User who made the modification to the proxy credentials.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ Date of proxy-credentials modification.", "format": "date-time", "readOnly": true, "type": "string" }, "password": { "description": "The password encoded in Base 64 format.", "minLength": 1, "type": "string" }, "username": { "description": "Name of proxy credential user.", "minLength": 1, "type": "string" } }, "required": [ "createdBy", "createdDate", "username" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-credential-specific.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/proxy-credentials-all.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List proxy credentials", "tags": [ "Proxy credentials" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/proxy-credentials.yaml", "path-info": "/configs/{configId}/proxy-credentials" } }, "/configs/{configId}/proxy-credentials/{userName}": { "get": { "description": "Provides the proxy credential info for the specified `userName`.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-proxy-credential" }, "operationId": "get-proxy-credential", "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": { "createdBy": "szhang", "createdDate": "2020-05-18T15:40:07.146+0000", "modifiedBy": "jsmith", "modifiedDate": "2020-07-22T18:49:06.031+0000", "username": "afero@1041" }, "schema": { "additionalProperties": false, "description": "Lists the properties of the requested proxy credentials.", "properties": { "createdBy": { "description": "Name of the user who created this proxy credential.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this proxy credential's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "modifiedBy": { "description": "User who made the modification to the proxy credentials.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ Date of proxy-credentials modification.", "format": "date-time", "readOnly": true, "type": "string" }, "password": { "description": "The password encoded in Base 64 format.", "minLength": 1, "type": "string" }, "username": { "description": "Name of proxy credential user.", "minLength": 1, "type": "string" } }, "required": [ "createdBy", "createdDate", "username" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-credential-specific.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get a proxy credential", "tags": [ "Proxy credentials" ] }, "delete": { "description": "Deletes a specific proxy credential.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/delete-proxy-credential" }, "operationId": "delete-proxy-credential", "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": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Remove a proxy credential", "tags": [ "Proxy credentials" ] }, "parameters": [ { "description": "User for the proxy credential.", "in": "path", "name": "userName", "required": true, "schema": { "example": "rocky", "type": "string" }, "x-akamai": { "file-path": "parameters/user-name-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/user-name.yaml", "path-info": "/configs/{configId}/proxy-credentials/{userName}" } }, "/configs/{configId}/recentChanges": { "get": { "description": "Returns all changes made since the last configuration deployment.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-config-recent-changes" }, "operationId": "get-config-recent-changes", "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": { "changes": [ { "changes": [ { "changeType": "Modified", "changes": [ { "changeType": "Modified", "changes": [ { "changeType": "Added", "detail": { "name": "192.0.2.125" } }, { "changeType": "Removed", "detail": { "name": "192.0.2.193" } } ], "detail": { "name": "Exit Point" } } ], "detail": { "id": 5782867, "modifiedBy": "adevi@sia.com", "modifiedDate": "2021-05-24T14:42:12.360+00:00", "name": "SITE 1" } }, { "changeType": "Added", "detail": { "id": 6840081, "modifiedBy": "jsmith@sia.com", "modifiedDate": "2021-07-22T09:56:01.083+00:00", "name": "New Site" } } ], "deltaType": "sites" }, { "changes": [ { "changeType": "Modified", "changes": [ { "changeType": "Modified", "detail": { "name": "Sublocation 1", "newValue": "East Site", "oldValue": "Site 1" } }, { "changeType": "Added", "detail": { "name": "East Site", "newValue": "sub" } } ], "detail": { "id": 540, "modifiedBy": "szhang@sia.com", "modifiedDate": "2021-07-21T17:09:51.863+00:00", "name": "East Site" } } ], "deltaType": "subLocations" }, { "changes": [ { "changeType": "Added", "detail": { "id": 170460, "modifiedBy": "hgildong@sia.com", "modifiedDate": "2021-07-22T12:28:34.456+00:00", "name": "List 1" } } ], "deltaType": "customlists" }, { "changeType": "Modified", "changes": [ { "changeType": "Modified", "detail": { "name": "Block Roaming Traffic", "newValue": "false", "oldValue": "true" } } ], "deltaType": "global_settings", "detail": { "id": 1, "modifiedBy": "jsmith@sia.com", "modifiedDate": "2021-07-23T19:36:23.414+00:00" } } ] }, "schema": { "additionalProperties": false, "description": "The recent changes compared to last deployment.", "properties": { "changes": { "description": "Recent change details.", "items": { "additionalProperties": false, "properties": { "changeType": { "description": "The change type, either `Modified`, `Added`, or `Removed`.", "enum": [ "Modified", "Added", "Removed" ], "type": "string" }, "changes": { "description": "The recent changes compared to last deployment.", "items": { "additionalProperties": false, "properties": { "changeType": { "description": "The change type, either `Modified`, `Added`, or `Removed`.", "enum": [ "Modified", "Added", "Removed" ], "type": "string" }, "changes": { "description": "Nested change objects.", "items": { "additionalProperties": false, "properties": { "changeType": { "description": "Specifies the type of change, either `Modified`, `Added`, or `Removed`.", "enum": [ "Modified", "Added", "Removed" ], "type": "string" }, "changes": { "description": "Nested change objects.", "items": { "additionalProperties": false, "properties": { "changeType": { "description": "Specifies the type of change, either `Modified`, `Added`, or `Removed`.", "enum": [ "Modified", "Added", "Removed" ], "type": "string" }, "detail": { "additionalProperties": false, "description": "Detail of the change.", "properties": { "id": { "description": "Unique identifier for the modification.", "minimum": 1, "type": "integer" }, "modifiedBy": { "description": "__Read-only__ User who made the modification.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp when the change was made.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the modified entity.", "minLength": 0, "type": "string" }, "newValue": { "description": "The value after the change.", "minLength": 0, "type": "string" }, "oldValue": { "description": "The value before the change.", "minLength": 1, "type": "string" } }, "type": "object" } }, "type": "object" }, "minItems": 0, "type": "array" }, "detail": { "additionalProperties": false, "description": "Detail of the change.", "properties": { "id": { "description": "Unique identifier for the modification.", "minimum": 1, "type": "integer" }, "modifiedBy": { "description": "User who made the modification.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp when the change was made.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the modified entity.", "minLength": 0, "type": "string" }, "newValue": { "description": "The value after the change.", "minLength": 1, "type": "string" }, "oldValue": { "description": "The value before the change.", "minLength": 1, "type": "string" } }, "type": "object" } }, "type": "object" }, "minItems": 0, "type": "array" }, "detail": { "additionalProperties": false, "description": "Describes the change details.", "properties": { "id": { "description": "A unique identifier for the change.", "minimum": 1, "type": "integer" }, "modifiedBy": { "description": "User who made the modification.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp when the change was made.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the change.", "minLength": 1, "type": "string" }, "newValue": { "description": "The value after the change.", "minLength": 1, "type": "string" }, "oldValue": { "description": "The value before the change.", "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } }, "type": "object" }, "minItems": 0, "type": "array" }, "deltaType": { "description": "Name of entity type changed. Either `sites`, `policies`, `lists`, `subLocations`, `customlists`, or `global_settings`.", "enum": [ "sites", "policies", "lists", "subLocations", "customlists", "global_settings" ], "type": "string" }, "detail": { "additionalProperties": false, "description": "Detail of the change.", "properties": { "id": { "description": "Unique identifier for the modification.", "minimum": 1, "type": "integer" }, "modifiedBy": { "description": "__Read-only__ User who made the modification.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp when the change was made.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the modified entity.", "minLength": 0, "type": "string" }, "newValue": { "description": "The value after the change.", "minLength": 0, "type": "string" }, "oldValue": { "description": "The value before the change.", "minLength": 0, "type": "string" } }, "type": "object" } }, "type": "object" }, "minItems": 0, "type": "array" } }, "required": [ "changes" ], "type": "object", "x-akamai": { "file-path": "schemas/etp-configuration-deployment-changes-made-since-last-deployment.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } } }, "summary": "List recent changes", "tags": [ "Deployment changes" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/recent-changes.yaml", "path-info": "/configs/{configId}/recentChanges" } }, "/configs/{configId}/sites": { "post": { "description": "Creates a new site.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-sites" }, "operationId": "post-sites", "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": { "description": "West site 1", "dynamicIpEnabled": true, "exitPoints": [ { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.137" } ], "ipsecOnrampcredential": { "password": "UGFzc3dvcmQx", "username": "adevi" }, "name": "West 1", "policyId": 1030 }, "schema": { "additionalProperties": false, "description": "IP addresses and CIDR blocks for an assigned policy based on a region or geographic area.", "properties": { "clientOverridePolicyId": { "description": "The unique ID of the related client override policy.", "type": "integer" }, "clientOverridePolicyInfo": { "additionalProperties": false, "description": "The unique policy for handling the traffic arriving from the Zero Trust Client or SIA Client.", "properties": { "id": { "description": "The unique ID for the policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "description": { "description": "A description of the site configuration that you provide.", "minLength": 1, "type": "string" }, "dynamicExitPoints": { "description": "Site dynamic exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The organizational IP address or CIDR block used to match requests to a policy.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "dynamicIpEnabled": { "description": "Enables dynamic IP onramp for the site.", "type": "boolean" }, "exitPoints": { "description": "Site exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The organizational IP address or CIDR block used to match requests to a policy.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "ipsecOnrampcredential": { "additionalProperties": false, "description": "IPsec credential properties.", "properties": { "password": { "description": "The password for the IPsec credential in base-64 format.", "format": "byte", "type": "string" }, "username": { "description": "The username for the IPsec credential.", "maxLength": 128, "minLength": 5, "type": "string" } }, "required": [ "password", "username" ], "type": "object" }, "ipsecOverDNSEnabled": { "description": "Enables DNS over IPsec protection for the site.", "type": "boolean" }, "name": { "description": "The name of the site configuration.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "The policy to apply to incoming DNS requests.", "properties": { "id": { "description": "The unique ID for the policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "useInternalIpPrivacyMask": { "description": "Applies an internal IP privacy mask.", "type": "boolean" } }, "required": [ "name" ], "type": "object", "x-akamai": { "file-path": "schemas/site-create.yaml" } } } } }, "responses": { "200": { "content": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Create a site", "tags": [ "Sites" ] }, "get": { "description": "Returns all sites for a configuration.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-sites" }, "operationId": "get-sites", "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": [ { "accessConfig": { "configurable": true, "delegatedAdmins": [], "readable": true }, "clientOverridePolicyId": 32987, "clientOverridePolicyInfo": { "id": 32987, "name": "Policy_corp" }, "createdBy": "szhang", "createdDate": "2022-03-04T12:21:12.299+00:00", "exitPoints": [ { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.228" }, { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.203" }, { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.171" }, { "addrType": "ADDR_TYPE_IPV6", "ipAddr": "2001:db8:53ff:142f:6a84:6d6d:4a9b:6ff4" } ], "id": 10959874, "isOffnetworkLocation": false, "modifiedBy": "hgildong", "modifiedDate": "2022-11-23T15:17:28.337+00:00", "name": "IPsec Ubuntu", "policyId": 32986, "policyInfo": { "id": 32986, "name": "IPSec staging Setup" }, "subLocations": [ { "accessConfig": { "configurable": true, "delegatedAdmins": [], "readable": true }, "createdBy": "hgildong", "createdDate": "2022-03-04T13:24:53.150+00:00", "exitPoints": [ { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.179/24" } ], "id": 9563, "isOffnetworkLocation": false, "modifiedBy": "szhang", "modifiedDate": "2022-11-23T06:24:37.000+00:00", "name": "subloc1", "policyId": 70801, "policyInfo": { "id": 70801, "name": "offnet policy for bglore team -remya" }, "subLocations": [] } ], "useInternalIpPrivacyMask": true } ], "schema": { "description": "Specifies IP addresses and CIDR blocks of a region or geographic area for an assigned policy.", "items": { "additionalProperties": false, "description": "Specifies IP addresses and CIDR blocks of a region or geographic area for an assigned policy.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access config details.", "properties": { "configurable": { "description": "Marks the site as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated admins for the site.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks the site as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "clientOverridePolicyId": { "description": "The unique ID of the related client override policy.", "minimum": 0, "type": "integer" }, "clientOverridePolicyInfo": { "additionalProperties": false, "description": "The unique policy for handling the traffic arriving from Zero Trust Client or SIA Client.", "properties": { "id": { "description": "The unique ID for the policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this site.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "deleted": { "description": "Indicates the site's deletion.", "type": "boolean" }, "description": { "description": "A description of the site configuration that you provide.", "minLength": 1, "type": "string" }, "dynamicExitPoints": { "description": "A site's dynamic exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "dynamicIpEnabled": { "description": "Enables dynamic IP onramp for the site.", "type": "boolean" }, "exitPoints": { "description": "Site exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "A unique identifier for the site. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "ipsecOnrampcredential": { "additionalProperties": false, "description": "IPsec credential properties.", "properties": { "dynamicIp": { "description": "Enables dynamic IP IPsec credential.", "type": "boolean" }, "metadataType": { "description": "The KMI credential type, either `IPSEC_CRED` or `PROXY_CRED`.", "enum": [ "IPSEC_CRED", "PROXY_CRED" ], "type": "string" }, "password": { "description": "The password for the IPsec credential.", "type": "string" }, "username": { "description": "The username for the IPsec credential.", "maxLength": 128, "minLength": 5, "type": "string" } }, "required": [ "username" ], "type": "object", "x-akamai": { "file-path": "schemas/credential.yaml" } }, "ipsecOverDNSEnabled": { "description": "Enables IPsec over DNS for the site.", "type": "boolean" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who most recently modified this site.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the site configuration.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Specifies the related policy SIA applies to incoming DNS requests.", "properties": { "id": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the related policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "additionalProperties": false, "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Indicates that the access config is configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "The admins delegated to manage the access config.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Indicates that the access config is readable.", "type": "boolean" } }, "required": [ "configurable", "readable" ], "type": "object" }, "createdBy": { "description": "Name of the user who created the sublocation.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking the sublocation's creation.", "minLength": 1, "type": "string" }, "exitPoints": { "description": "Site sublocation exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "minLength": 1, "type": "string" }, "ipAddr": { "description": "The IP address.", "minLength": 1, "type": "string" } }, "required": [ "addrType", "ipAddr" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "The sublocation's unique ID. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who last modified the sublocation.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking the sublocation's last modification.", "minLength": 1, "type": "string" }, "name": { "description": "The sublocation name.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Policy details.", "properties": { "id": { "description": "The policy's unique ID.", "minimum": 0, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "policyId", "isOffnetworkLocation", "subLocations", "accessConfig", "policyInfo", "exitPoints" ], "type": "object" }, "minItems": 0, "type": "array" }, "useInternalIpPrivacyMask": { "description": "Applies internal IP privacy mask.", "type": "boolean" } }, "required": [ "name", "exitPoints", "policyId" ], "type": "object", "x-akamai": { "file-path": "schemas/site-retrieve-specific.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/site-retrieve-all.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "detail": "The name :Site11 is not unique. Code-090415", "instance": "6702ffa9-3d06-4c5d-a099-1f7e2759bea2", "status": 409, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-409.yaml" } } } }, "description": "[Conflict with current state of resource](https://techdocs.akamai.com/etp-config/reference/409). Use the `X-etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/conflict-409.yaml" } } }, "summary": "List sites", "tags": [ "Sites" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/sites.yaml", "path-info": "/configs/{configId}/sites" } }, "/configs/{configId}/sites-meta-info": { "get": { "description": "Provides site meta info details.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-sites-meta-info" }, "operationId": "get-sites-meta-info", "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": [ { "accessConfig": { "configurable": true, "delegatedAdmins": [ "delegatedUser@org.com" ], "readable": true }, "clientOverridePolicyId": 32987, "clientOverridePolicyInfo": { "id": 32987, "name": "Policy_corp" }, "createdBy": "mrossi", "createdDate": "2017-04-25T22:26:15.687+0000", "description": "IPs not assigned to a configured Location", "exitPoints": [ { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.6" } ], "id": 2160, "isOffnetworkLocation": false, "modifiedBy": "mrossi", "modifiedDate": "2017-04-25T22:26:15.687+0000", "name": "Unidentified IPs", "policyId": 2480, "policyInfo": { "id": 2480, "name": "Default" } } ], "schema": { "description": "Specifies IP addresses and CIDR blocks of a region or geographic area for an assigned policy.", "items": { "additionalProperties": false, "description": "Specifies IP addresses and CIDR blocks of a region or geographic area for an assigned policy.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access config details.", "properties": { "configurable": { "description": "Marks the site as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated admins for the site.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks the site as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "clientOverridePolicyId": { "description": "The unique ID of the related client override policy.", "minimum": 0, "type": "integer" }, "clientOverridePolicyInfo": { "additionalProperties": false, "description": "The unique policy for handling the traffic arriving from Zero Trust Client or SIA Client.", "properties": { "id": { "description": "The unique ID for the policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this site.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "deleted": { "description": "Indicates the site's deletion.", "type": "boolean" }, "description": { "description": "A description of the site configuration that you provide.", "minLength": 1, "type": "string" }, "dynamicExitPoints": { "description": "A site's dynamic exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "dynamicIpEnabled": { "description": "Enables dynamic IP onramp for the site.", "type": "boolean" }, "exitPoints": { "description": "Site exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "A unique identifier for the site. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "ipsecOnrampcredential": { "additionalProperties": false, "description": "IPsec credential properties.", "properties": { "dynamicIp": { "description": "Enables dynamic IP IPsec credential.", "type": "boolean" }, "metadataType": { "description": "The KMI credential type, either `IPSEC_CRED` or `PROXY_CRED`.", "enum": [ "IPSEC_CRED", "PROXY_CRED" ], "type": "string" }, "password": { "description": "The password for the IPsec credential.", "type": "string" }, "username": { "description": "The username for the IPsec credential.", "maxLength": 128, "minLength": 5, "type": "string" } }, "required": [ "username" ], "type": "object", "x-akamai": { "file-path": "schemas/credential.yaml" } }, "ipsecOverDNSEnabled": { "description": "Enables IPsec over DNS for the site.", "type": "boolean" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who most recently modified this site.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the site configuration.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Specifies the related policy SIA applies to incoming DNS requests.", "properties": { "id": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the related policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "additionalProperties": false, "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Indicates that the access config is configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "The admins delegated to manage the access config.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Indicates that the access config is readable.", "type": "boolean" } }, "required": [ "configurable", "readable" ], "type": "object" }, "createdBy": { "description": "Name of the user who created the sublocation.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking the sublocation's creation.", "minLength": 1, "type": "string" }, "exitPoints": { "description": "Site sublocation exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "minLength": 1, "type": "string" }, "ipAddr": { "description": "The IP address.", "minLength": 1, "type": "string" } }, "required": [ "addrType", "ipAddr" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "The sublocation's unique ID. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who last modified the sublocation.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking the sublocation's last modification.", "minLength": 1, "type": "string" }, "name": { "description": "The sublocation name.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Policy details.", "properties": { "id": { "description": "The policy's unique ID.", "minimum": 0, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "policyId", "isOffnetworkLocation", "subLocations", "accessConfig", "policyInfo", "exitPoints" ], "type": "object" }, "minItems": 0, "type": "array" }, "useInternalIpPrivacyMask": { "description": "Applies internal IP privacy mask.", "type": "boolean" } }, "required": [ "name", "exitPoints", "policyId" ], "type": "object", "x-akamai": { "file-path": "schemas/site-retrieve-specific.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/sites-meta-info-all.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get site metadata", "tags": [ "Sites" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/sites-meta-info.yaml", "path-info": "/configs/{configId}/sites-meta-info" } }, "/configs/{configId}/sites/bulk": { "post": { "description": "Uploads sites in bulk using a CSV file:\n- maximum of 100 sites per file\n- supports comma-delimited or tab-delimited files\n- must include all headers in the file.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-sites-bulk-upload" }, "operationId": "post-sites-bulk-upload", "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": { "text/csv": { "examples": { "ex-comma-delimited": { "summary": "Comma-delimited CSV", "value": { "$ref": "../examples/location-bulk-request-comma.csv" } }, "ex-tab-delimited": { "summary": "Tab-delimited CSV", "value": { "$ref": "../examples/location-bulk-request-tabbed.csv" } } }, "schema": { "description": "CSV data.", "minLength": 1, "type": "string", "x-akamai": { "file-path": "schemas/location-bulk-upload-csv.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": [], "schema": { "description": "Empty array indicating successful bulk site upload.", "items": { "type": "string" }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/location-upload-success.yaml" } } } }, "description": "Successful response." }, "206": { "content": { "application/json": { "example": [ { "description": "EMEA east", "dynamicExitPoints": [], "error": "The name east-corp is not unique. Code-090415", "exitPoints": [ { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.234" } ], "isOffnetworkLocation": false, "name": "east-corp", "policyInfo": { "name": "" }, "subLocations": [] } ], "schema": { "description": "Partial failure of location upload. These sub-locations couldn't be created from CSV file due to validation issues. ", "items": { "additionalProperties": false, "properties": { "description": { "description": "The location description. ", "type": "string" }, "dynamicExitPoints": { "description": "The location's dynamic exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type. Either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "type": "string" } }, "type": "object" }, "type": "array" }, "error": { "description": "An error describing the validation issue.", "type": "string" }, "exitPoints": { "description": "The exit points for the location.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type. Either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "type": "string" } }, "type": "object" }, "type": "array" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "name": { "description": "The location name.", "type": "string" }, "policyInfo": { "additionalProperties": false, "description": "The policy info for the location.", "properties": { "name": { "description": "The policy name for the location.", "type": "string" } }, "type": "object" }, "subLocations": { "description": "The site's sublocations.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array", "x-akamai": { "file-path": "schemas/location-upload-response-partial-failure.yaml" } } } }, "description": "Bulk CSV validation response. Partial failure to parse data." }, "404": { "content": { "application/problem+json": { "examples": { "ex-duplicate-sitename": { "summary": "Duplicate site name found in the CSV file.", "value": { "$ref": "../examples/csv-duplicate-sitename-400.json" } }, "ex-empty-file": { "summary": "Empty CSV file.", "value": { "$ref": "../examples/csv-empty-file-400.json" } }, "ex-invalid-headers": { "summary": "Missing required headers in the CSV file.", "value": { "$ref": "../examples/csv-validation-error-400.json" } }, "ex-invalid-ip-address": { "summary": "Invalid IP address found in the CSV file.", "value": { "$ref": "../examples/csv-invalid-ip-address-400.json" } } }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 400 error response.", "properties": { "detail": { "description": "A short, human-readable problem solution including a specific error code.", "type": "string" }, "instance": { "description": "The unique ID for this error.", "type": "string" }, "status": { "description": "The HTTP problem type.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "title", "instance", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/csv-problem-400.yaml" } } } }, "description": "[CSV file header validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/csv-validation-error-400.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error during the bulk upload process", "instance": "/etp-config/config/sites/bulk", "status": 500, "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/etp-config/proxy/upload-request-error" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "Internal server error.", "x-akamai": { "file-path": "errors/csv-upload-error-500.yaml" } } }, "summary": "Bulk create sites", "tags": [ "Sites" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/location-bulk-upload.yaml", "path-info": "/configs/{configId}/sites/bulk" } }, "/configs/{configId}/sites/{siteId}": { "get": { "description": "Returns the details of a specific Site.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-site" }, "operationId": "get-site", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "accessConfig": { "configurable": true, "delegatedAdmins": [], "readable": true }, "clientOverridePolicyId": 32987, "clientOverridePolicyInfo": { "id": 32987, "name": "Policy_corp" }, "createdBy": "jperez", "createdDate": "2022-03-04T12:21:12.299+00:00", "dynamicIpEnabled": true, "exitPoints": [ { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.96" }, { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.13" }, { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.86" }, { "addrType": "ADDR_TYPE_IPV6", "ipAddr": "2001:db8:aa0f:e1e1:b3b1:d223:11d2:3730" } ], "id": 10959874, "ipsecOnrampcredential": { "dynamicIp": false, "metadataType": "IPSEC_CRED", "username": "adevi@ipsec.akasia.net" }, "ipsecOverDNSEnabled": false, "isOffnetworkLocation": false, "modifiedBy": "jkowalski", "modifiedDate": "2022-11-23T15:17:28.337+00:00", "name": "IPsec Ubuntu", "policyId": 32986, "policyInfo": { "id": 32986, "name": "IPSec staging Setup" }, "subLocations": [ { "accessConfig": { "configurable": true, "delegatedAdmins": [], "readable": true }, "createdBy": "jkowalski", "createdDate": "2022-03-04T13:24:53.150+00:00", "exitPoints": [ { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.176/24" } ], "id": 9563, "isOffnetworkLocation": false, "modifiedBy": "jperez", "modifiedDate": "2022-11-23T06:24:37.000+00:00", "name": "subloc1", "policyId": 70801, "policyInfo": { "id": 70801, "name": "offnet policy for bglore team -remya" }, "subLocations": [] } ], "useInternalIpPrivacyMask": true }, "schema": { "additionalProperties": false, "description": "Specifies IP addresses and CIDR blocks of a region or geographic area for an assigned policy.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access config details.", "properties": { "configurable": { "description": "Marks the site as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated admins for the site.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks the site as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "clientOverridePolicyId": { "description": "The unique ID of the related client override policy.", "minimum": 0, "type": "integer" }, "clientOverridePolicyInfo": { "additionalProperties": false, "description": "The unique policy for handling the traffic arriving from Zero Trust Client or SIA Client.", "properties": { "id": { "description": "The unique ID for the policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this site.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "deleted": { "description": "Indicates the site's deletion.", "type": "boolean" }, "description": { "description": "A description of the site configuration that you provide.", "minLength": 1, "type": "string" }, "dynamicExitPoints": { "description": "A site's dynamic exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "dynamicIpEnabled": { "description": "Enables dynamic IP onramp for the site.", "type": "boolean" }, "exitPoints": { "description": "Site exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "A unique identifier for the site. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "ipsecOnrampcredential": { "additionalProperties": false, "description": "IPsec credential properties.", "properties": { "dynamicIp": { "description": "Enables dynamic IP IPsec credential.", "type": "boolean" }, "metadataType": { "description": "The KMI credential type, either `IPSEC_CRED` or `PROXY_CRED`.", "enum": [ "IPSEC_CRED", "PROXY_CRED" ], "type": "string" }, "password": { "description": "The password for the IPsec credential.", "type": "string" }, "username": { "description": "The username for the IPsec credential.", "maxLength": 128, "minLength": 5, "type": "string" } }, "required": [ "username" ], "type": "object", "x-akamai": { "file-path": "schemas/credential.yaml" } }, "ipsecOverDNSEnabled": { "description": "Enables IPsec over DNS for the site.", "type": "boolean" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who most recently modified this site.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the site configuration.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Specifies the related policy SIA applies to incoming DNS requests.", "properties": { "id": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the related policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "additionalProperties": false, "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Indicates that the access config is configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "The admins delegated to manage the access config.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Indicates that the access config is readable.", "type": "boolean" } }, "required": [ "configurable", "readable" ], "type": "object" }, "createdBy": { "description": "Name of the user who created the sublocation.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking the sublocation's creation.", "minLength": 1, "type": "string" }, "exitPoints": { "description": "Site sublocation exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "minLength": 1, "type": "string" }, "ipAddr": { "description": "The IP address.", "minLength": 1, "type": "string" } }, "required": [ "addrType", "ipAddr" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "The sublocation's unique ID. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who last modified the sublocation.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking the sublocation's last modification.", "minLength": 1, "type": "string" }, "name": { "description": "The sublocation name.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Policy details.", "properties": { "id": { "description": "The policy's unique ID.", "minimum": 0, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "policyId", "isOffnetworkLocation", "subLocations", "accessConfig", "policyInfo", "exitPoints" ], "type": "object" }, "minItems": 0, "type": "array" }, "useInternalIpPrivacyMask": { "description": "Applies internal IP privacy mask.", "type": "boolean" } }, "required": [ "name", "exitPoints", "policyId" ], "type": "object", "x-akamai": { "file-path": "schemas/site-retrieve-specific.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "detail": "The name :Site11 is not unique. Code-090415", "instance": "6702ffa9-3d06-4c5d-a099-1f7e2759bea2", "status": 409, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-409.yaml" } } } }, "description": "[Conflict with current state of resource](https://techdocs.akamai.com/etp-config/reference/409). Use the `X-etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/conflict-409.yaml" } } }, "summary": "Get a site", "tags": [ "Sites" ] }, "put": { "description": "Modifies site details.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-site" }, "operationId": "put-site", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "This is Akamai's site", "exitPoints": [ { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.131" } ], "name": "Akamai Site 1", "policyId": 1030 }, "schema": { "additionalProperties": false, "description": "Specifies IP addresses and CIDR blocks of a region or geographic area for an assigned policy.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access config details.", "properties": { "configurable": { "description": "Marks the site as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated admins for the site.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks the site as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "clientOverridePolicyId": { "description": "The unique ID of the related client override policy.", "minimum": 0, "type": "integer" }, "clientOverridePolicyInfo": { "additionalProperties": false, "description": "The unique policy for handling the traffic arriving from Zero Trust Client or SIA Client.", "properties": { "id": { "description": "The unique ID for the policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this site.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "deleted": { "description": "Indicates the site's deletion.", "type": "boolean" }, "description": { "description": "A description of the site configuration that you provide.", "minLength": 1, "type": "string" }, "dynamicExitPoints": { "description": "A site's dynamic exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "dynamicIpEnabled": { "description": "Enables dynamic IP onramp for the site.", "type": "boolean" }, "exitPoints": { "description": "Site exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "A unique identifier for the site. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "ipsecOnrampcredential": { "additionalProperties": false, "description": "IPsec credential properties.", "properties": { "dynamicIp": { "description": "Enables dynamic IP IPsec credential.", "type": "boolean" }, "metadataType": { "description": "The KMI credential type, either `IPSEC_CRED` or `PROXY_CRED`.", "enum": [ "IPSEC_CRED", "PROXY_CRED" ], "type": "string" }, "password": { "description": "The password for the IPsec credential.", "type": "string" }, "username": { "description": "The username for the IPsec credential.", "maxLength": 128, "minLength": 5, "type": "string" } }, "required": [ "username" ], "type": "object", "x-akamai": { "file-path": "schemas/credential.yaml" } }, "ipsecOverDNSEnabled": { "description": "Enables IPsec over DNS for the site.", "type": "boolean" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who most recently modified this site.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the site configuration.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Specifies the related policy SIA applies to incoming DNS requests.", "properties": { "id": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the related policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "additionalProperties": false, "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Indicates that the access config is configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "The admins delegated to manage the access config.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Indicates that the access config is readable.", "type": "boolean" } }, "required": [ "configurable", "readable" ], "type": "object" }, "createdBy": { "description": "Name of the user who created the sublocation.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking the sublocation's creation.", "minLength": 1, "type": "string" }, "exitPoints": { "description": "Site sublocation exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "minLength": 1, "type": "string" }, "ipAddr": { "description": "The IP address.", "minLength": 1, "type": "string" } }, "required": [ "addrType", "ipAddr" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "The sublocation's unique ID. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who last modified the sublocation.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking the sublocation's last modification.", "minLength": 1, "type": "string" }, "name": { "description": "The sublocation name.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Policy details.", "properties": { "id": { "description": "The policy's unique ID.", "minimum": 0, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "policyId", "isOffnetworkLocation", "subLocations", "accessConfig", "policyInfo", "exitPoints" ], "type": "object" }, "minItems": 0, "type": "array" }, "useInternalIpPrivacyMask": { "description": "Applies internal IP privacy mask.", "type": "boolean" } }, "required": [ "name", "exitPoints", "policyId" ], "type": "object", "x-akamai": { "file-path": "schemas/site-retrieve-specific.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Update a site", "tags": [ "Sites" ] }, "delete": { "description": "Deletes a specific site. Add an `If-Match` header to prevent deleting any data another client has modified since you last accessed it.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/delete-site" }, "operationId": "delete-site", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Remove a site", "tags": [ "Sites" ] }, "parameters": [ { "description": "A unique identifier for a site.", "in": "path", "name": "siteId", "required": true, "schema": { "example": 101, "type": "integer" }, "x-akamai": { "file-path": "parameters/site-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/site.yaml", "path-info": "/configs/{configId}/sites/{siteId}" } }, "/configs/{configId}/sites/{siteId}/sub-locations": { "post": { "description": "Creates a sublocation.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-site-sublocation" }, "operationId": "post-site-sublocation", "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": { "description": "West site 1", "dynamicIpEnabled": true, "exitPoints": [ { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.137" } ], "ipsecOnrampcredential": { "password": "UGFzc3dvcmQx", "username": "adevi" }, "name": "West 1", "policyId": 1030 }, "schema": { "additionalProperties": false, "description": "Specifies IP addresses and CIDR blocks of a region or geographic area for an assigned policy.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access config details.", "properties": { "configurable": { "description": "Marks the site as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated admins for the site.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks the site as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "clientOverridePolicyId": { "description": "The unique ID of the related client override policy.", "minimum": 0, "type": "integer" }, "clientOverridePolicyInfo": { "additionalProperties": false, "description": "The unique policy for handling the traffic arriving from Zero Trust Client or SIA Client.", "properties": { "id": { "description": "The unique ID for the policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this site.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "deleted": { "description": "Indicates the site's deletion.", "type": "boolean" }, "description": { "description": "A description of the site configuration that you provide.", "minLength": 1, "type": "string" }, "dynamicExitPoints": { "description": "A site's dynamic exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "dynamicIpEnabled": { "description": "Enables dynamic IP onramp for the site.", "type": "boolean" }, "exitPoints": { "description": "Site exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "A unique identifier for the site. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "ipsecOnrampcredential": { "additionalProperties": false, "description": "IPsec credential properties.", "properties": { "dynamicIp": { "description": "Enables dynamic IP IPsec credential.", "type": "boolean" }, "metadataType": { "description": "The KMI credential type, either `IPSEC_CRED` or `PROXY_CRED`.", "enum": [ "IPSEC_CRED", "PROXY_CRED" ], "type": "string" }, "password": { "description": "The password for the IPsec credential.", "type": "string" }, "username": { "description": "The username for the IPsec credential.", "maxLength": 128, "minLength": 5, "type": "string" } }, "required": [ "username" ], "type": "object", "x-akamai": { "file-path": "schemas/credential.yaml" } }, "ipsecOverDNSEnabled": { "description": "Enables IPsec over DNS for the site.", "type": "boolean" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who most recently modified this site.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the site configuration.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Specifies the related policy SIA applies to incoming DNS requests.", "properties": { "id": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the related policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "additionalProperties": false, "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Indicates that the access config is configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "The admins delegated to manage the access config.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Indicates that the access config is readable.", "type": "boolean" } }, "required": [ "configurable", "readable" ], "type": "object" }, "createdBy": { "description": "Name of the user who created the sublocation.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking the sublocation's creation.", "minLength": 1, "type": "string" }, "exitPoints": { "description": "Site sublocation exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "minLength": 1, "type": "string" }, "ipAddr": { "description": "The IP address.", "minLength": 1, "type": "string" } }, "required": [ "addrType", "ipAddr" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "The sublocation's unique ID. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who last modified the sublocation.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking the sublocation's last modification.", "minLength": 1, "type": "string" }, "name": { "description": "The sublocation name.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Policy details.", "properties": { "id": { "description": "The policy's unique ID.", "minimum": 0, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "policyId", "isOffnetworkLocation", "subLocations", "accessConfig", "policyInfo", "exitPoints" ], "type": "object" }, "minItems": 0, "type": "array" }, "useInternalIpPrivacyMask": { "description": "Applies internal IP privacy mask.", "type": "boolean" } }, "required": [ "name", "exitPoints", "policyId" ], "type": "object", "x-akamai": { "file-path": "schemas/site-retrieve-specific.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Create a sublocation", "tags": [ "Sub-locations" ] }, "get": { "description": "Returns the list of sublocations for the site.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-site-sublocations" }, "operationId": "get-site-sublocations", "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": [ { "accessConfig": { "configurable": true, "delegatedAdmins": [], "readable": true }, "createdBy": "jsmith", "createdDate": "2021-09-21T05:27:02.131+00:00", "exitPoints": [ { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.238/24" } ], "id": 2878, "isOffnetworkLocation": false, "modifiedBy": "alfulani", "modifiedDate": "2021-09-21T05:27:02.131+00:00", "name": "sub", "policyId": 4120, "policyInfo": { "id": 4120, "name": "P1" }, "subLocations": [] } ], "schema": { "description": "Sublocation information.", "items": { "additionalProperties": false, "properties": { "accessConfig": { "additionalProperties": false, "description": "Details of the sublocation's access config.", "properties": { "configurable": { "description": "Whether the sublocation's access config is configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "The admins delegated to manage the access config.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Whether the sublocation's access config is readable.", "type": "boolean" } }, "required": [ "configurable", "readable", "delegatedAdmins" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this sublocation.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking this sublocation's creation.", "minLength": 1, "type": "string" }, "exitPoints": { "description": "The exit point IP address details.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The exit point IP address type.", "minLength": 1, "type": "string" }, "ipAddr": { "description": "The exit point IP address.", "minLength": 1, "type": "string" } }, "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique ID of the sublocation.", "minimum": 1, "type": "integer" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who most recently modified this sublocation.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking this sublocation's last modification.", "minLength": 1, "type": "string" }, "name": { "description": "The sublocation name.", "minLength": 1, "type": "string" }, "policyId": { "description": "Unique ID of the sublocation's policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Details of the sublocation's policy.", "properties": { "id": { "description": "The policy's unique ID.", "minimum": 1, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "type": "object" }, "subLocations": { "description": "Nested sublocation information.", "items": { "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "id", "name", "policyId", "isOffnetworkLocation", "subLocations", "accessConfig" ], "type": "object" }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/sub-locations-all.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List sublocations", "tags": [ "Sub-locations" ] }, "parameters": [ { "description": "A unique identifier for a site.", "in": "path", "name": "siteId", "required": true, "schema": { "example": 101, "type": "integer" }, "x-akamai": { "file-path": "parameters/site-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/sub-locations.yaml", "path-info": "/configs/{configId}/sites/{siteId}/sub-locations" } }, "/configs/{configId}/sites/{siteId}/sub-locations/{subLocationId}": { "get": { "description": "Returns a sublocation detail.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-site-sublocation" }, "operationId": "get-site-sublocation", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "accessConfig": { "configurable": true, "delegatedAdmins": [], "readable": true }, "clientOverridePolicyId": 32987, "clientOverridePolicyInfo": { "id": 32987, "name": "Policy_corp" }, "createdBy": "jperez", "createdDate": "2022-03-04T12:21:12.299+00:00", "dynamicIpEnabled": true, "exitPoints": [ { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.96" }, { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.13" }, { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.86" }, { "addrType": "ADDR_TYPE_IPV6", "ipAddr": "2001:db8:aa0f:e1e1:b3b1:d223:11d2:3730" } ], "id": 10959874, "ipsecOnrampcredential": { "dynamicIp": false, "metadataType": "IPSEC_CRED", "username": "adevi@ipsec.akasia.net" }, "ipsecOverDNSEnabled": false, "isOffnetworkLocation": false, "modifiedBy": "jkowalski", "modifiedDate": "2022-11-23T15:17:28.337+00:00", "name": "IPsec Ubuntu", "policyId": 32986, "policyInfo": { "id": 32986, "name": "IPSec staging Setup" }, "subLocations": [ { "accessConfig": { "configurable": true, "delegatedAdmins": [], "readable": true }, "createdBy": "jkowalski", "createdDate": "2022-03-04T13:24:53.150+00:00", "exitPoints": [ { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.176/24" } ], "id": 9563, "isOffnetworkLocation": false, "modifiedBy": "jperez", "modifiedDate": "2022-11-23T06:24:37.000+00:00", "name": "subloc1", "policyId": 70801, "policyInfo": { "id": 70801, "name": "offnet policy for bglore team -remya" }, "subLocations": [] } ], "useInternalIpPrivacyMask": true }, "schema": { "additionalProperties": false, "description": "Specifies IP addresses and CIDR blocks of a region or geographic area for an assigned policy.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access config details.", "properties": { "configurable": { "description": "Marks the site as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated admins for the site.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks the site as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "clientOverridePolicyId": { "description": "The unique ID of the related client override policy.", "minimum": 0, "type": "integer" }, "clientOverridePolicyInfo": { "additionalProperties": false, "description": "The unique policy for handling the traffic arriving from Zero Trust Client or SIA Client.", "properties": { "id": { "description": "The unique ID for the policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this site.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "deleted": { "description": "Indicates the site's deletion.", "type": "boolean" }, "description": { "description": "A description of the site configuration that you provide.", "minLength": 1, "type": "string" }, "dynamicExitPoints": { "description": "A site's dynamic exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "dynamicIpEnabled": { "description": "Enables dynamic IP onramp for the site.", "type": "boolean" }, "exitPoints": { "description": "Site exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "A unique identifier for the site. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "ipsecOnrampcredential": { "additionalProperties": false, "description": "IPsec credential properties.", "properties": { "dynamicIp": { "description": "Enables dynamic IP IPsec credential.", "type": "boolean" }, "metadataType": { "description": "The KMI credential type, either `IPSEC_CRED` or `PROXY_CRED`.", "enum": [ "IPSEC_CRED", "PROXY_CRED" ], "type": "string" }, "password": { "description": "The password for the IPsec credential.", "type": "string" }, "username": { "description": "The username for the IPsec credential.", "maxLength": 128, "minLength": 5, "type": "string" } }, "required": [ "username" ], "type": "object", "x-akamai": { "file-path": "schemas/credential.yaml" } }, "ipsecOverDNSEnabled": { "description": "Enables IPsec over DNS for the site.", "type": "boolean" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who most recently modified this site.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the site configuration.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Specifies the related policy SIA applies to incoming DNS requests.", "properties": { "id": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the related policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "additionalProperties": false, "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Indicates that the access config is configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "The admins delegated to manage the access config.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Indicates that the access config is readable.", "type": "boolean" } }, "required": [ "configurable", "readable" ], "type": "object" }, "createdBy": { "description": "Name of the user who created the sublocation.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking the sublocation's creation.", "minLength": 1, "type": "string" }, "exitPoints": { "description": "Site sublocation exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "minLength": 1, "type": "string" }, "ipAddr": { "description": "The IP address.", "minLength": 1, "type": "string" } }, "required": [ "addrType", "ipAddr" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "The sublocation's unique ID. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who last modified the sublocation.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking the sublocation's last modification.", "minLength": 1, "type": "string" }, "name": { "description": "The sublocation name.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Policy details.", "properties": { "id": { "description": "The policy's unique ID.", "minimum": 0, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "policyId", "isOffnetworkLocation", "subLocations", "accessConfig", "policyInfo", "exitPoints" ], "type": "object" }, "minItems": 0, "type": "array" }, "useInternalIpPrivacyMask": { "description": "Applies internal IP privacy mask.", "type": "boolean" } }, "required": [ "name", "exitPoints", "policyId" ], "type": "object", "x-akamai": { "file-path": "schemas/site-retrieve-specific.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get a sublocation", "tags": [ "Sub-locations" ] }, "put": { "description": "Updates the sublocation.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-site-sublocation" }, "operationId": "put-site-sublocation", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "This is Akamai's site", "exitPoints": [ { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.131" } ], "name": "Akamai Site 1", "policyId": 1030 }, "schema": { "additionalProperties": false, "description": "Specifies IP addresses and CIDR blocks of a region or geographic area for an assigned policy.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access config details.", "properties": { "configurable": { "description": "Marks the site as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated admins for the site.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks the site as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "clientOverridePolicyId": { "description": "The unique ID of the related client override policy.", "minimum": 0, "type": "integer" }, "clientOverridePolicyInfo": { "additionalProperties": false, "description": "The unique policy for handling the traffic arriving from Zero Trust Client or SIA Client.", "properties": { "id": { "description": "The unique ID for the policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this site.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "deleted": { "description": "Indicates the site's deletion.", "type": "boolean" }, "description": { "description": "A description of the site configuration that you provide.", "minLength": 1, "type": "string" }, "dynamicExitPoints": { "description": "A site's dynamic exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "dynamicIpEnabled": { "description": "Enables dynamic IP onramp for the site.", "type": "boolean" }, "exitPoints": { "description": "Site exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "A unique identifier for the site. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "ipsecOnrampcredential": { "additionalProperties": false, "description": "IPsec credential properties.", "properties": { "dynamicIp": { "description": "Enables dynamic IP IPsec credential.", "type": "boolean" }, "metadataType": { "description": "The KMI credential type, either `IPSEC_CRED` or `PROXY_CRED`.", "enum": [ "IPSEC_CRED", "PROXY_CRED" ], "type": "string" }, "password": { "description": "The password for the IPsec credential.", "type": "string" }, "username": { "description": "The username for the IPsec credential.", "maxLength": 128, "minLength": 5, "type": "string" } }, "required": [ "username" ], "type": "object", "x-akamai": { "file-path": "schemas/credential.yaml" } }, "ipsecOverDNSEnabled": { "description": "Enables IPsec over DNS for the site.", "type": "boolean" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who most recently modified this site.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the site configuration.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Specifies the related policy SIA applies to incoming DNS requests.", "properties": { "id": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the related policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "additionalProperties": false, "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Indicates that the access config is configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "The admins delegated to manage the access config.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Indicates that the access config is readable.", "type": "boolean" } }, "required": [ "configurable", "readable" ], "type": "object" }, "createdBy": { "description": "Name of the user who created the sublocation.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking the sublocation's creation.", "minLength": 1, "type": "string" }, "exitPoints": { "description": "Site sublocation exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "minLength": 1, "type": "string" }, "ipAddr": { "description": "The IP address.", "minLength": 1, "type": "string" } }, "required": [ "addrType", "ipAddr" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "The sublocation's unique ID. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who last modified the sublocation.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking the sublocation's last modification.", "minLength": 1, "type": "string" }, "name": { "description": "The sublocation name.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Policy details.", "properties": { "id": { "description": "The policy's unique ID.", "minimum": 0, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "policyId", "isOffnetworkLocation", "subLocations", "accessConfig", "policyInfo", "exitPoints" ], "type": "object" }, "minItems": 0, "type": "array" }, "useInternalIpPrivacyMask": { "description": "Applies internal IP privacy mask.", "type": "boolean" } }, "required": [ "name", "exitPoints", "policyId" ], "type": "object", "x-akamai": { "file-path": "schemas/site-retrieve-specific.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Update a sublocation", "tags": [ "Sub-locations" ] }, "delete": { "description": "Deletes a specific sublocation. Add an `If-Match` header to prevent deleting any data another client has modified since you last accessed it.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/delete-site-sublocation" }, "operationId": "delete-site-sublocation", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Remove a sublocation", "tags": [ "Sub-locations" ] }, "parameters": [ { "description": "A unique identifier for a location.", "in": "path", "name": "subLocationId", "required": true, "schema": { "example": 102, "type": "integer" }, "x-akamai": { "file-path": "parameters/sub-location-id-path.yaml" } }, { "description": "A unique identifier for a site.", "in": "path", "name": "siteId", "required": true, "schema": { "example": 101, "type": "integer" }, "x-akamai": { "file-path": "parameters/site-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/sub-location.yaml", "path-info": "/configs/{configId}/sites/{siteId}/sub-locations/{subLocationId}" } }, "/configs/{configId}/sites/{siteId}/sub-locations/{subLocationId}/op/assign-policy": { "post": { "description": "Assigns a policy to the site.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-sublocation-policy" }, "operationId": "post-sublocation-policy", "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": { "description": "West site 1", "dynamicIpEnabled": true, "exitPoints": [ { "addrType": "ADDR_TYPE_IPV4", "ipAddr": "192.0.2.137" } ], "ipsecOnrampcredential": { "password": "UGFzc3dvcmQx", "username": "adevi" }, "name": "West 1", "policyId": 1030 }, "schema": { "additionalProperties": false, "description": "Specifies IP addresses and CIDR blocks of a region or geographic area for an assigned policy.", "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access config details.", "properties": { "configurable": { "description": "Marks the site as configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "Delegated admins for the site.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Marks the site as readable.", "type": "boolean" } }, "required": [ "configurable", "delegatedAdmins", "readable" ], "type": "object" }, "clientOverridePolicyId": { "description": "The unique ID of the related client override policy.", "minimum": 0, "type": "integer" }, "clientOverridePolicyInfo": { "additionalProperties": false, "description": "The unique policy for handling the traffic arriving from Zero Trust Client or SIA Client.", "properties": { "id": { "description": "The unique ID for the policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "createdBy": { "description": "Name of the user who created this site.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "deleted": { "description": "Indicates the site's deletion.", "type": "boolean" }, "description": { "description": "A description of the site configuration that you provide.", "minLength": 1, "type": "string" }, "dynamicExitPoints": { "description": "A site's dynamic exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "dynamicIpEnabled": { "description": "Enables dynamic IP onramp for the site.", "type": "boolean" }, "exitPoints": { "description": "Site exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "enum": [ "ADDR_TYPE_IPV4", "ADDR_TYPE_IPV6" ], "type": "string" }, "ipAddr": { "description": "The IP address or CIDR block for your company used to match a policy to a request.", "minLength": 1, "type": "string" } }, "required": [ "ipAddr", "addrType" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "A unique identifier for the site. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "ipsecOnrampcredential": { "additionalProperties": false, "description": "IPsec credential properties.", "properties": { "dynamicIp": { "description": "Enables dynamic IP IPsec credential.", "type": "boolean" }, "metadataType": { "description": "The KMI credential type, either `IPSEC_CRED` or `PROXY_CRED`.", "enum": [ "IPSEC_CRED", "PROXY_CRED" ], "type": "string" }, "password": { "description": "The password for the IPsec credential.", "type": "string" }, "username": { "description": "The username for the IPsec credential.", "maxLength": 128, "minLength": 5, "type": "string" } }, "required": [ "username" ], "type": "object", "x-akamai": { "file-path": "schemas/credential.yaml" } }, "ipsecOverDNSEnabled": { "description": "Enables IPsec over DNS for the site.", "type": "boolean" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who most recently modified this site.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this site's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "The name of the site configuration.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Specifies the related policy SIA applies to incoming DNS requests.", "properties": { "id": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the related policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "additionalProperties": false, "properties": { "accessConfig": { "additionalProperties": false, "description": "Provides access configuration details.", "properties": { "configurable": { "description": "Indicates that the access config is configurable.", "type": "boolean" }, "delegatedAdmins": { "description": "The admins delegated to manage the access config.", "items": { "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "readable": { "description": "Indicates that the access config is readable.", "type": "boolean" } }, "required": [ "configurable", "readable" ], "type": "object" }, "createdBy": { "description": "Name of the user who created the sublocation.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking the sublocation's creation.", "minLength": 1, "type": "string" }, "exitPoints": { "description": "Site sublocation exit points.", "items": { "additionalProperties": false, "properties": { "addrType": { "description": "The IP address type, either `ADDR_TYPE_IPV4` or `ADDR_TYPE_IPV6`.", "minLength": 1, "type": "string" }, "ipAddr": { "description": "The IP address.", "minLength": 1, "type": "string" } }, "required": [ "addrType", "ipAddr" ], "type": "object" }, "minItems": 0, "type": "array" }, "id": { "description": "The sublocation's unique ID. Use this value for `siteId` in subsequent operations.", "minimum": 1, "type": "integer" }, "isOffnetworkLocation": { "description": "Indicates if the site is an off-network location.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who last modified the sublocation.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking the sublocation's last modification.", "minLength": 1, "type": "string" }, "name": { "description": "The sublocation name.", "minLength": 1, "type": "string" }, "policyId": { "description": "The unique ID of the related policy.", "minimum": 1, "type": "integer" }, "policyInfo": { "additionalProperties": false, "description": "Policy details.", "properties": { "id": { "description": "The policy's unique ID.", "minimum": 0, "type": "integer" }, "name": { "description": "The policy name.", "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" }, "subLocations": { "description": "Nested sublocation instances.", "items": { "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "name", "policyId", "isOffnetworkLocation", "subLocations", "accessConfig", "policyInfo", "exitPoints" ], "type": "object" }, "minItems": 0, "type": "array" }, "useInternalIpPrivacyMask": { "description": "Applies internal IP privacy mask.", "type": "boolean" } }, "required": [ "name", "exitPoints", "policyId" ], "type": "object", "x-akamai": { "file-path": "schemas/site-retrieve-specific.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Assign a policy to a site", "tags": [ "Sites" ] }, "parameters": [ { "description": "A unique identifier for a location.", "in": "path", "name": "subLocationId", "required": true, "schema": { "example": 102, "type": "integer" }, "x-akamai": { "file-path": "parameters/sub-location-id-path.yaml" } }, { "description": "A unique identifier for a site.", "in": "path", "name": "siteId", "required": true, "schema": { "example": 101, "type": "integer" }, "x-akamai": { "file-path": "parameters/site-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/assign-policy.yaml", "path-info": "/configs/{configId}/sites/{siteId}/sub-locations/{subLocationId}/op/assign-policy" } }, "/configs/{configId}/tenants": { "get": { "description": "Returns all tenants.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-tenants" }, "operationId": "get-tenants", "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": [ { "createdBy": "hgildong", "createdDate": "2021-08-06T18:44:03.000+00:00", "id": 26452, "modifiedBy": "jperez", "modifiedDate": "2021-08-06T18:44:03.000+00:00", "name": "BuildCo", "users": [] }, { "createdBy": "jperez", "createdDate": "2021-08-06T18:44:03.000+00:00", "id": 26450, "modifiedBy": "tyamada", "modifiedDate": "2021-08-06T18:44:03.000+00:00", "name": "Flowers R Us", "users": [] } ], "schema": { "description": "Tenants.", "items": { "additionalProperties": false, "description": "Tenant onboard request details.", "properties": { "createdBy": { "description": "Name of the user who created this tenant.", "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking the tenant's creation.", "type": "string" }, "groupIds": { "description": "Group identifiers with access to the tenant.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "hideSetupWizard": { "description": "Hides the setup wizard.", "type": "boolean" }, "id": { "description": "Unique identifier for the tenant.", "minimum": 1, "type": "integer" }, "inheritClientConfig": { "description": "Whether to inherit the client configuration from the parent.", "type": "boolean" }, "inheritErrorPage": { "description": "Whether to inherit the error page from the tenant's parent.", "type": "boolean" }, "inheritNetworkConfig": { "description": "Whether to inherit the network configuration from the parent.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who most recently modified this tenant.", "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking this site's last modification.", "type": "string" }, "name": { "description": "Unique name for the tenant.", "minLength": 1, "type": "string" }, "policyTemplateId": { "description": "__Read-only__ Identifies the tenant's policy template.", "minimum": 1, "readOnly": true, "type": "integer" }, "users": { "description": "Array of assigned tenant users.", "items": { "additionalProperties": false, "description": "Tenant user details.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the user.", "minimum": 1, "readOnly": true, "type": "integer" }, "isViewer": { "description": "Whether the user has only the viewer role.", "type": "boolean" }, "uiIdentityId": { "description": "The user identifier.", "minLength": 1, "type": "string" }, "uiUserName": { "description": "The username of the tenant user.", "minLength": 1, "type": "string" } }, "required": [ "id", "uiIdentityId", "uiUserName" ], "type": "object", "x-akamai": { "file-path": "schemas/tenant-user.yaml" } }, "minItems": 0, "type": "array" }, "viewerUsers": { "description": "Array of tenant viewer users.", "items": { "additionalProperties": false, "description": "Tenant user details.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the user.", "minimum": 1, "readOnly": true, "type": "integer" }, "isViewer": { "description": "Whether the user has only the viewer role.", "type": "boolean" }, "uiIdentityId": { "description": "The user identifier.", "minLength": 1, "type": "string" }, "uiUserName": { "description": "The username of the tenant user.", "minLength": 1, "type": "string" } }, "required": [ "id", "uiIdentityId", "uiUserName" ], "type": "object", "x-akamai": { "file-path": "schemas/tenant-user.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "name", "id", "users" ], "type": "object", "x-akamai": { "file-path": "schemas/tenant-detail-response.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/tenants-list.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List all tenants", "tags": [ "Tenants" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/tenants.yaml", "path-info": "/configs/{configId}/tenants" } }, "/configs/{configId}/tenants/{tenantId}": { "get": { "description": "Returns a tenant details.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-tenant" }, "operationId": "get-tenant", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "createdBy": "jsmith", "createdDate": "2021-08-06T18:44:03.000+00:00", "id": 26452, "modifiedBy": "jkowalski", "modifiedDate": "2021-08-06T18:44:03.000+00:00", "name": "enterprise16", "users": [] }, "schema": { "additionalProperties": false, "description": "Tenant onboard request details.", "properties": { "createdBy": { "description": "Name of the user who created this tenant.", "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking the tenant's creation.", "type": "string" }, "groupIds": { "description": "Group identifiers with access to the tenant.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "hideSetupWizard": { "description": "Hides the setup wizard.", "type": "boolean" }, "id": { "description": "Unique identifier for the tenant.", "minimum": 1, "type": "integer" }, "inheritClientConfig": { "description": "Whether to inherit the client configuration from the parent.", "type": "boolean" }, "inheritErrorPage": { "description": "Whether to inherit the error page from the tenant's parent.", "type": "boolean" }, "inheritNetworkConfig": { "description": "Whether to inherit the network configuration from the parent.", "type": "boolean" }, "modifiedBy": { "description": "Name of the user who most recently modified this tenant.", "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking this site's last modification.", "type": "string" }, "name": { "description": "Unique name for the tenant.", "minLength": 1, "type": "string" }, "policyTemplateId": { "description": "__Read-only__ Identifies the tenant's policy template.", "minimum": 1, "readOnly": true, "type": "integer" }, "users": { "description": "Array of assigned tenant users.", "items": { "additionalProperties": false, "description": "Tenant user details.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the user.", "minimum": 1, "readOnly": true, "type": "integer" }, "isViewer": { "description": "Whether the user has only the viewer role.", "type": "boolean" }, "uiIdentityId": { "description": "The user identifier.", "minLength": 1, "type": "string" }, "uiUserName": { "description": "The username of the tenant user.", "minLength": 1, "type": "string" } }, "required": [ "id", "uiIdentityId", "uiUserName" ], "type": "object", "x-akamai": { "file-path": "schemas/tenant-user.yaml" } }, "minItems": 0, "type": "array" }, "viewerUsers": { "description": "Array of tenant viewer users.", "items": { "additionalProperties": false, "description": "Tenant user details.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the user.", "minimum": 1, "readOnly": true, "type": "integer" }, "isViewer": { "description": "Whether the user has only the viewer role.", "type": "boolean" }, "uiIdentityId": { "description": "The user identifier.", "minLength": 1, "type": "string" }, "uiUserName": { "description": "The username of the tenant user.", "minLength": 1, "type": "string" } }, "required": [ "id", "uiIdentityId", "uiUserName" ], "type": "object", "x-akamai": { "file-path": "schemas/tenant-user.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "name", "id", "users" ], "type": "object", "x-akamai": { "file-path": "schemas/tenant-detail-response.yaml" } } } }, "description": "Tenant onboard request details." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get a tenant", "tags": [ "Tenants" ] }, "put": { "description": "Updates the specified tenant.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-tenant" }, "operationId": "put-tenant", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "enterprisestaging31", "users": [ { "id": 225, "uiIdentityId": "F-XX-3840197", "uiUserName": "user@sia.com" } ] }, "schema": { "additionalProperties": false, "description": "Tenant onboard request details.", "properties": { "groupIds": { "description": "Group identifiers with access to the tenant.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "hideSetupWizard": { "description": "Hides the setup wizard.", "type": "boolean" }, "id": { "description": "Unique identifier for the tenant.", "minimum": 1, "type": "integer" }, "inheritClientConfig": { "description": "Whether to inherit the client configuration from the parent.", "type": "boolean" }, "inheritErrorPage": { "description": "Whether to inherit the error page from the tenant's parent.", "type": "boolean" }, "inheritNetworkConfig": { "description": "Whether to inherit the network configuration from the parent.", "type": "boolean" }, "name": { "description": "Unique name for the tenant.", "minLength": 1, "type": "string" }, "policyTemplateId": { "description": "__Read-only__ Identifies the tenant's policy template.", "minimum": 1, "readOnly": true, "type": "integer" }, "users": { "description": "Array of assigned tenant users.", "items": { "additionalProperties": false, "description": "Tenant user details.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the user.", "minimum": 1, "readOnly": true, "type": "integer" }, "isViewer": { "description": "Whether the user has only the viewer role.", "type": "boolean" }, "uiIdentityId": { "description": "The user identifier.", "minLength": 1, "type": "string" }, "uiUserName": { "description": "The username of the tenant user.", "minLength": 1, "type": "string" } }, "required": [ "id", "uiIdentityId", "uiUserName" ], "type": "object", "x-akamai": { "file-path": "schemas/tenant-user.yaml" } }, "minItems": 0, "type": "array" }, "viewerUsers": { "description": "Array of tenant viewer users.", "items": { "additionalProperties": false, "description": "Tenant user details.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the user.", "minimum": 1, "readOnly": true, "type": "integer" }, "isViewer": { "description": "Whether the user has only the viewer role.", "type": "boolean" }, "uiIdentityId": { "description": "The user identifier.", "minLength": 1, "type": "string" }, "uiUserName": { "description": "The username of the tenant user.", "minLength": 1, "type": "string" } }, "required": [ "id", "uiIdentityId", "uiUserName" ], "type": "object", "x-akamai": { "file-path": "schemas/tenant-user.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "name", "users" ], "type": "object", "x-akamai": { "file-path": "schemas/tenant-detail-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Update a tenant", "tags": [ "Tenants" ] }, "delete": { "description": "Deletes a specific tenant.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/delete-tenant" }, "operationId": "delete-tenant", "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": {}, "description": "Successful removed the tenant." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Remove a tenant", "tags": [ "Tenants" ] }, "parameters": [ { "description": "A unique identifier for the tenant.", "in": "path", "name": "tenantId", "required": true, "schema": { "example": "26452", "type": "string" }, "x-akamai": { "file-path": "parameters/tenant-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/tenant.yaml", "path-info": "/configs/{configId}/tenants/{tenantId}" } }, "/configs/{configId}/tenants/{tenantId}/users": { "get": { "description": "Lists details of users assigned to a tenant.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-tenant-users" }, "operationId": "get-tenant-users", "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": [ { "id": 261, "uiIdentityId": "F-XX-3597276", "uiUserName": "abc.akamai@gmail.com" }, { "id": 381, "uiIdentityId": "F-XX-3844385", "uiUserName": "def@gmail.com" } ], "schema": { "description": "Tenant user details.", "items": { "additionalProperties": false, "description": "Tenant user details.", "properties": { "id": { "description": "__Read-only__ A unique identifier for the user.", "minimum": 1, "readOnly": true, "type": "integer" }, "isViewer": { "description": "Whether the user has only the viewer role.", "type": "boolean" }, "uiIdentityId": { "description": "The user identifier.", "minLength": 1, "type": "string" }, "uiUserName": { "description": "The username of the tenant user.", "minLength": 1, "type": "string" } }, "required": [ "id", "uiIdentityId", "uiUserName" ], "type": "object", "x-akamai": { "file-path": "schemas/tenant-user.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/tenant-user-list.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List tenant users", "tags": [ "Tenants" ] }, "parameters": [ { "description": "A unique identifier for the tenant.", "in": "path", "name": "tenantId", "required": true, "schema": { "example": "26452", "type": "string" }, "x-akamai": { "file-path": "parameters/tenant-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/users.yaml", "path-info": "/configs/{configId}/tenants/{tenantId}/users" } }, "/configs/{configId}/vpn-credentials": { "post": { "description": "Creates a new VPN credential.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-vpn-credentials" }, "operationId": "post-vpn-credentials", "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": { "encPsk": "S3VtYXJANTM3Nw==", "ikeId": "lgumpina" }, "schema": { "additionalProperties": false, "description": "The properties for VPN credential creation.", "properties": { "encPsk": { "description": "The password encoded in Base64 format.", "format": "byte", "type": "string" }, "ikeId": { "description": "Internet key exchange (IKE) identifier of the VPN credential.", "minLength": 1, "type": "string" } }, "required": [ "ikeId" ], "type": "object", "x-akamai": { "file-path": "schemas/vpn-credential-create.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Create a VPN credential", "tags": [ "VPN credentials" ] }, "get": { "description": "Provides all VPN credentials.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-vpn-credentials" }, "operationId": "get-vpn-credentials", "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": [ { "createdBy": "jkowalski", "createdDate": "2022-01-25T15:16:57.886+00:00", "ikeId": "siadev1990-62588@ipsec.akasia.net", "modifiedBy": "jsmith", "modifiedDate": "2022-02-14T09:23:32.570+00:00" }, { "createdBy": "jsmith", "createdDate": "2022-01-25T15:16:57.886+00:00", "ikeId": "lgumpina-62588@ipsec.akasia.net", "modifiedBy": "mrossi", "modifiedDate": "2022-02-14T09:23:32.570+00:00" }, { "createdBy": "jsmith", "createdDate": "2022-01-25T15:16:57.886+00:00", "ikeId": "sianevada-62588@ipsec.akaetp.net", "modifiedBy": "jsmith", "modifiedDate": "2022-02-14T09:23:32.570+00:00" } ], "schema": { "description": "Lists the properties of the VPN credentials.", "items": { "additionalProperties": false, "description": "Lists the properties of the VPN credential.", "properties": { "createdBy": { "description": "Name of the user who created this proxy credential.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this proxy credential's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "encPsk": { "description": "The user password encoded in Base64 format.", "format": "byte", "type": "string" }, "ikeId": { "description": "The Internet key exchange (IKE) identifier of the VPN credential.", "minLength": 1, "type": "string" }, "modifiedBy": { "description": "User who last modified the proxy credentials.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the proxy credential's last modification.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "createdBy", "createdDate", "ikeId" ], "type": "object", "x-akamai": { "file-path": "schemas/vpn-credential-specific.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/vpn-credentials-all.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List VPN credentials", "tags": [ "VPN credentials" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/vpn-credentials.yaml", "path-info": "/configs/{configId}/vpn-credentials" } }, "/configs/{configId}/vpn-credentials/{ikeId}": { "get": { "description": "Provides details for the specified VPN credential.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-vpn-credential-details" }, "operationId": "get-vpn-credential-details", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "createdBy": "tyamada", "createdDate": "2022-01-25T15:16:57.886+00:00", "ikeId": "lgumpina-62588@ipsec.akasia.net", "modifiedBy": "mrossi", "modifiedDate": "2022-02-14T09:23:32.570+00:00" }, "schema": { "additionalProperties": false, "description": "Lists the properties of the VPN credential.", "properties": { "createdBy": { "description": "Name of the user who created this proxy credential.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking this proxy credential's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "encPsk": { "description": "The user password encoded in Base64 format.", "format": "byte", "type": "string" }, "ikeId": { "description": "The Internet key exchange (IKE) identifier of the VPN credential.", "minLength": 1, "type": "string" }, "modifiedBy": { "description": "User who last modified the proxy credentials.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the proxy credential's last modification.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "createdBy", "createdDate", "ikeId" ], "type": "object", "x-akamai": { "file-path": "schemas/vpn-credential-specific.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get a VPN credential", "tags": [ "VPN credentials" ] }, "delete": { "description": "Deletes the specified VPN credential.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/delete-vpn-credential" }, "operationId": "delete-vpn-credential", "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": {}, "description": "Deletion successful." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Delete a VPN credential", "tags": [ "VPN credentials" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } }, { "description": "The Internet key exchange (IKE) identifier of the VPN credential.", "in": "path", "name": "ikeId", "required": true, "schema": { "example": "akamai.com", "type": "string" }, "x-akamai": { "file-path": "parameters/ike-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/ike.yaml", "path-info": "/configs/{configId}/vpn-credentials/{ikeId}" } }, "/customers/{configId}/certificates": { "post": { "description": "Creates a new proxy certificate.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-customers-certificate" }, "operationId": "post-customers-certificate", "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": { "caMode": "AKAMAI", "certificate": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo6gAwIBAgIIf8Ji8Dm81ko ... TXV0qe8SEF+C5n4=\n-----END CERTIFICATE-----" }, "schema": { "additionalProperties": false, "description": "Contains data about a TLS certificate.", "properties": { "caMode": { "description": "Mode of the certificate, either `CUSTOMER` or `AKAMAI`.", "enum": [ "CUSTOMER", "AKAMAI" ], "type": "string" }, "certificate": { "description": "Value of the certificate in PEM format. ASCII, base64-encoded text starting with `-----BEGIN CERTIFICATE-----` and ending with `-----END CERTIFICATE-----`.", "type": "string" }, "certificateId": { "description": "__Read-only__ A unique identifier for each certificate.", "minimum": 1, "readOnly": true, "type": "integer" }, "certificateRequest": { "description": "Value for the certificate signing request (CSR). ASCII, base64-encoded text starting with `-----BEGIN CERTIFICATE REQUEST-----` and ending with `-----END CERTIFICATE REQUEST-----`.", "format": "byte", "type": "string" }, "createdBy": { "description": "Name of the user who created this certificate.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "expiredDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's expiration.", "format": "date-time", "readOnly": true, "type": "string" }, "fingerprint": { "description": "The certificate's hexadecimal fingerprint.", "minLength": 1, "type": "string" }, "issuedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's issue.", "format": "date-time", "readOnly": true, "type": "string" }, "modifiedBy": { "description": "Name of the user who most recently modified this certificate. If there haven't been any modifications, the value matches `createdBy`.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this certificate's last modification. If there haven't been any modifications, the value matches `createdDate`.", "format": "date-time", "readOnly": true, "type": "string" }, "status": { "description": "__Read-only__ The certificate's deployment status. Either `CREATING`, `UPDATING`, `PENDING_DOWNLOAD`, `PENDING_DISTRIBUTION`, `PENDING_ACTIVATION`, `ACTIVATING`, `ACTIVATED`, `DEACTIVATING`, `DEACTIVATED`, `EXPIRED` or `INCOMPLETE`.", "enum": [ "CREATING", "UPDATING", "PENDING_DOWNLOAD", "PENDING_DISTRIBUTION", "PENDING_ACTIVATION", "ACTIVATING", "ACTIVATED", "DEACTIVATING", "DEACTIVATED", "EXPIRED", "INCOMPLETE" ], "readOnly": true, "type": "string" } }, "required": [ "certificate", "caMode" ], "type": "object", "x-akamai": { "file-path": "schemas/certificate.yaml" } } } }, "required": true }, "responses": { "201": { "content": {}, "description": "Successful response.", "headers": { "Location": { "description": "Location URL for the newly created resource.", "schema": { "example": "https://xyzcorp.akamai.com/etp-config/v3/configs/238461/sites/304204", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Create a new proxy certificate", "tags": [ "Proxy certificates" ] }, "get": { "description": "Returns all available proxy certificates.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-customers-certificates" }, "operationId": "get-customers-certificates", "parameters": [ { "description": "Indicates if the response includes ISO 8601 timestamp fields for debugging, `false` by default.", "in": "query", "name": "debug", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/debuggable-debug.yaml" } }, { "description": "When `true`, the response includes the certificate block, `false` by default.", "in": "query", "name": "include-certificate", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/certificate-query-params-include-certificate.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "caMode": "AKAMAI", "certificate": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo6gAwIBAgIIf8Ji8Dm81ko ... TXV0qe8SEF+C5n4=\n-----END CERTIFICATE-----", "certificateId": 5001, "expiredDate": "2019-10-11T00:15:38+0000", "fingerprint": "D1:AB:01:1C:A1:DE:CA:FC:0F:FE:E1:5F:EA:51:B1:E0", "issuedDate": "2016-10-11T00:15:38+0000", "status": "PENDING_ACTIVATION" }, { "caMode": "CUSTOMER", "certificate": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo6gAwIBAgIIf8Ji8Dm81ko ... TXV0qe8SEF+C5n4=\n-----END CERTIFICATE-----", "certificateId": 5002, "expiredDate": "2018-10-11T00:15:38+0000", "fingerprint": "BA:AD:CA:FE:F0:0D:AC:CE:55:1B:1E:15:AB:E1:1A:00", "issuedDate": "2015-10-11T00:15:38+0000", "status": "ACTIVATED" } ], "schema": { "description": "TLS certificates.", "items": { "additionalProperties": false, "description": "Contains data about a TLS certificate.", "properties": { "caMode": { "description": "Mode of the certificate, either `CUSTOMER` or `AKAMAI`.", "enum": [ "CUSTOMER", "AKAMAI" ], "type": "string" }, "certificate": { "description": "Value of the certificate in PEM format. ASCII, base64-encoded text starting with `-----BEGIN CERTIFICATE-----` and ending with `-----END CERTIFICATE-----`.", "type": "string" }, "certificateId": { "description": "__Read-only__ A unique identifier for each certificate.", "minimum": 1, "readOnly": true, "type": "integer" }, "certificateRequest": { "description": "Value for the certificate signing request (CSR). ASCII, base64-encoded text starting with `-----BEGIN CERTIFICATE REQUEST-----` and ending with `-----END CERTIFICATE REQUEST-----`.", "format": "byte", "type": "string" }, "createdBy": { "description": "Name of the user who created this certificate.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "expiredDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's expiration.", "format": "date-time", "readOnly": true, "type": "string" }, "fingerprint": { "description": "The certificate's hexadecimal fingerprint.", "minLength": 1, "type": "string" }, "issuedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's issue.", "format": "date-time", "readOnly": true, "type": "string" }, "modifiedBy": { "description": "Name of the user who most recently modified this certificate. If there haven't been any modifications, the value matches `createdBy`.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this certificate's last modification. If there haven't been any modifications, the value matches `createdDate`.", "format": "date-time", "readOnly": true, "type": "string" }, "status": { "description": "__Read-only__ The certificate's deployment status. Either `CREATING`, `UPDATING`, `PENDING_DOWNLOAD`, `PENDING_DISTRIBUTION`, `PENDING_ACTIVATION`, `ACTIVATING`, `ACTIVATED`, `DEACTIVATING`, `DEACTIVATED`, `EXPIRED` or `INCOMPLETE`.", "enum": [ "CREATING", "UPDATING", "PENDING_DOWNLOAD", "PENDING_DISTRIBUTION", "PENDING_ACTIVATION", "ACTIVATING", "ACTIVATED", "DEACTIVATING", "DEACTIVATED", "EXPIRED", "INCOMPLETE" ], "readOnly": true, "type": "string" } }, "required": [ "certificate", "caMode" ], "type": "object", "x-akamai": { "file-path": "schemas/certificate.yaml" } }, "minItems": 1, "type": "array", "x-akamai": { "file-path": "schemas/certificates.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List proxy certificates", "tags": [ "Proxy certificates" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/certificates.yaml", "path-info": "/customers/{configId}/certificates" } }, "/customers/{configId}/certificates/{certificateId}": { "get": { "description": "Returns the details of the specified proxy certificate.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-customers-certificate" }, "operationId": "get-customers-certificate", "parameters": [ { "description": "Indicates if the response includes ISO 8601 timestamp fields for debugging, `false` by default.", "in": "query", "name": "debug", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/debuggable-debug.yaml" } }, { "description": "When `true`, the response includes the certificate block, `false` by default.", "in": "query", "name": "include-certificate", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/certificate-query-params-include-certificate.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "caMode": "AKAMAI", "certificate": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo6gAwIBAgIIf8Ji8Dm81ko ... TXV0qe8SEF+C5n4=\n-----END CERTIFICATE-----", "certificateId": 5001, "expiredDate": "2019-10-11T00:15:38+0000", "fingerprint": "D1:AB:01:1C:A1:DE:CA:FC:0F:FE:E1:5F:EA:51:B1:E0", "issuedDate": "2016-10-11T00:15:38+0000", "status": "PENDING_ACTIVATION" }, "schema": { "additionalProperties": false, "description": "Contains data about a TLS certificate.", "properties": { "caMode": { "description": "Mode of the certificate, either `CUSTOMER` or `AKAMAI`.", "enum": [ "CUSTOMER", "AKAMAI" ], "type": "string" }, "certificate": { "description": "Value of the certificate in PEM format. ASCII, base64-encoded text starting with `-----BEGIN CERTIFICATE-----` and ending with `-----END CERTIFICATE-----`.", "type": "string" }, "certificateId": { "description": "__Read-only__ A unique identifier for each certificate.", "minimum": 1, "readOnly": true, "type": "integer" }, "certificateRequest": { "description": "Value for the certificate signing request (CSR). ASCII, base64-encoded text starting with `-----BEGIN CERTIFICATE REQUEST-----` and ending with `-----END CERTIFICATE REQUEST-----`.", "format": "byte", "type": "string" }, "createdBy": { "description": "Name of the user who created this certificate.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "expiredDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's expiration.", "format": "date-time", "readOnly": true, "type": "string" }, "fingerprint": { "description": "The certificate's hexadecimal fingerprint.", "minLength": 1, "type": "string" }, "issuedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's issue.", "format": "date-time", "readOnly": true, "type": "string" }, "modifiedBy": { "description": "Name of the user who most recently modified this certificate. If there haven't been any modifications, the value matches `createdBy`.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this certificate's last modification. If there haven't been any modifications, the value matches `createdDate`.", "format": "date-time", "readOnly": true, "type": "string" }, "status": { "description": "__Read-only__ The certificate's deployment status. Either `CREATING`, `UPDATING`, `PENDING_DOWNLOAD`, `PENDING_DISTRIBUTION`, `PENDING_ACTIVATION`, `ACTIVATING`, `ACTIVATED`, `DEACTIVATING`, `DEACTIVATED`, `EXPIRED` or `INCOMPLETE`.", "enum": [ "CREATING", "UPDATING", "PENDING_DOWNLOAD", "PENDING_DISTRIBUTION", "PENDING_ACTIVATION", "ACTIVATING", "ACTIVATED", "DEACTIVATING", "DEACTIVATED", "EXPIRED", "INCOMPLETE" ], "readOnly": true, "type": "string" } }, "required": [ "certificate", "caMode" ], "type": "object", "x-akamai": { "file-path": "schemas/certificate.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Get a proxy certificate", "tags": [ "Proxy certificates" ] }, "put": { "description": "Updates the value of a proxy certificate.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-customers-certificate" }, "operationId": "put-customers-certificate", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "caMode": "AKAMAI", "certificate": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo6gAwIBAgIIf8Ji8Dm81ko ... TXV0qe8SEF+C5n4=\n-----END CERTIFICATE-----" }, "schema": { "additionalProperties": false, "description": "Contains data about a TLS certificate.", "properties": { "caMode": { "description": "Mode of the certificate, either `CUSTOMER` or `AKAMAI`.", "enum": [ "CUSTOMER", "AKAMAI" ], "type": "string" }, "certificate": { "description": "Value of the certificate in PEM format. ASCII, base64-encoded text starting with `-----BEGIN CERTIFICATE-----` and ending with `-----END CERTIFICATE-----`.", "type": "string" }, "certificateId": { "description": "__Read-only__ A unique identifier for each certificate.", "minimum": 1, "readOnly": true, "type": "integer" }, "certificateRequest": { "description": "Value for the certificate signing request (CSR). ASCII, base64-encoded text starting with `-----BEGIN CERTIFICATE REQUEST-----` and ending with `-----END CERTIFICATE REQUEST-----`.", "format": "byte", "type": "string" }, "createdBy": { "description": "Name of the user who created this certificate.", "minLength": 1, "type": "string" }, "createdDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "expiredDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's expiration.", "format": "date-time", "readOnly": true, "type": "string" }, "fingerprint": { "description": "The certificate's hexadecimal fingerprint.", "minLength": 1, "type": "string" }, "issuedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the certificate's issue.", "format": "date-time", "readOnly": true, "type": "string" }, "modifiedBy": { "description": "Name of the user who most recently modified this certificate. If there haven't been any modifications, the value matches `createdBy`.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking this certificate's last modification. If there haven't been any modifications, the value matches `createdDate`.", "format": "date-time", "readOnly": true, "type": "string" }, "status": { "description": "__Read-only__ The certificate's deployment status. Either `CREATING`, `UPDATING`, `PENDING_DOWNLOAD`, `PENDING_DISTRIBUTION`, `PENDING_ACTIVATION`, `ACTIVATING`, `ACTIVATED`, `DEACTIVATING`, `DEACTIVATED`, `EXPIRED` or `INCOMPLETE`.", "enum": [ "CREATING", "UPDATING", "PENDING_DOWNLOAD", "PENDING_DISTRIBUTION", "PENDING_ACTIVATION", "ACTIVATING", "ACTIVATED", "DEACTIVATING", "DEACTIVATED", "EXPIRED", "INCOMPLETE" ], "readOnly": true, "type": "string" } }, "required": [ "certificate", "caMode" ], "type": "object", "x-akamai": { "file-path": "schemas/certificate.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Modify a proxy certificate", "tags": [ "Proxy certificates" ] }, "parameters": [ { "description": "A unique identifier for the certificate.", "in": "path", "name": "certificateId", "required": true, "schema": { "example": 5001, "type": "integer" }, "x-akamai": { "file-path": "parameters/certificate-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/certificate.yaml", "path-info": "/customers/{configId}/certificates/{certificateId}" } }, "/customers/{configId}/certificates/{certificateId}/op/activate": { "post": { "description": "Transitions the proxy certificate's state from `PENDING_ACTIVATION` to `ACTIVE`.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-customers-certificate-activate" }, "operationId": "post-customers-certificate-activate", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Activate a proxy certificate", "tags": [ "Proxy certificates" ] }, "parameters": [ { "description": "A unique identifier for the certificate.", "in": "path", "name": "certificateId", "required": true, "schema": { "example": 5001, "type": "integer" }, "x-akamai": { "file-path": "parameters/certificate-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/activate.yaml", "path-info": "/customers/{configId}/certificates/{certificateId}/op/activate" } }, "/customers/{configId}/certificates/{certificateId}/op/confirm-distribution": { "post": { "description": "Transitions the certificate's state from `PENDING_DISTRIBUTION` to `PENDING_ACTIVATION`. Only perform this operation after distributing the proxy certificates to relevant enterprise devices.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-certificate-confirm-distribution" }, "operationId": "post-certificate-confirm-distribution", "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": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Confirm a proxy certificate's distribution", "tags": [ "Proxy certificates" ] }, "parameters": [ { "description": "A unique identifier for the certificate.", "in": "path", "name": "certificateId", "required": true, "schema": { "example": 5001, "type": "integer" }, "x-akamai": { "file-path": "parameters/certificate-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/confirm-distribution.yaml", "path-info": "/customers/{configId}/certificates/{certificateId}/op/confirm-distribution" } }, "/customers/{configId}/certificates/{certificateId}/op/confirm-download": { "post": { "description": "Transitions the certificate's state from `PENDING_DOWNLOAD` to `PENDING_ACTIVATION` or `INCOMPLETE`.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-certificate-confirm-download" }, "operationId": "post-certificate-confirm-download", "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": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Confirm a proxy certificate's download", "tags": [ "Proxy certificates" ] }, "parameters": [ { "description": "A unique identifier for the certificate.", "in": "path", "name": "certificateId", "required": true, "schema": { "example": 5001, "type": "integer" }, "x-akamai": { "file-path": "parameters/certificate-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/confirm-download.yaml", "path-info": "/customers/{configId}/certificates/{certificateId}/op/confirm-download" } }, "/customers/{configId}/certificates/{certificateId}/op/deactivate": { "post": { "description": "Transitions the proxy certificate's state from any state to `DEACTIVATING`.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/post-certificate-deactivate" }, "operationId": "post-certificate-deactivate", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "Deactivate a proxy certificate", "tags": [ "Proxy certificates" ] }, "parameters": [ { "description": "A unique identifier for the certificate.", "in": "path", "name": "certificateId", "required": true, "schema": { "example": 5001, "type": "integer" }, "x-akamai": { "file-path": "parameters/certificate-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/deactivate.yaml", "path-info": "/customers/{configId}/certificates/{certificateId}/op/deactivate" } }, "/responses": { "get": { "description": "Returns all available Akamai built-in responses.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-responses" }, "operationId": "get-responses", "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": [ { "allowedForAup": false, "allowedForDnsPolicy": true, "allowedForSecurity": false, "description": "Drop", "id": 3, "name": "Drop" }, { "allowedForAup": true, "allowedForDnsPolicy": true, "allowedForSecurity": true, "description": "Error", "id": 4, "name": "Block - Error Page" }, { "allowedForAup": false, "allowedForDnsPolicy": false, "allowedForSecurity": false, "description": "Warn", "id": 7, "name": "Warn" }, { "allowedForAup": false, "allowedForDnsPolicy": true, "allowedForSecurity": true, "description": "Allow", "id": 1, "name": "Monitor" }, { "allowedForAup": true, "allowedForDnsPolicy": true, "allowedForSecurity": true, "description": "Deny", "id": 2, "name": "Block - DNS" }, { "allowedForAup": true, "allowedForDnsPolicy": true, "allowedForSecurity": true, "description": "Allow", "id": 5, "name": "Allow" }, { "allowedForAup": true, "allowedForDnsPolicy": false, "allowedForSecurity": true, "description": "Classify", "id": 6, "name": "Classify" }, { "allowedForAup": false, "allowedForDnsPolicy": false, "allowedForSecurity": false, "description": "DNS On-Ramp", "id": 8, "name": "DNS On-Ramp" }, { "allowedForAup": false, "allowedForDnsPolicy": false, "allowedForSecurity": false, "description": "Allow and Scan", "id": 9, "name": "Allow and Scan" }, { "allowedForAup": true, "allowedForDnsPolicy": true, "allowedForSecurity": true, "description": "Bypass", "id": 10, "name": "Bypass" }, { "allowedForAup": false, "allowedForDnsPolicy": false, "allowedForSecurity": false, "description": "N/A", "id": -1, "name": "N/A" } ], "schema": { "description": "Built-in responses.", "items": { "additionalProperties": false, "properties": { "allowedForAup": { "description": "Allows AUP responses.", "type": "boolean" }, "allowedForDnsPolicy": { "description": "Allows DNS policy responses.", "type": "boolean" }, "allowedForSecurity": { "description": "Allows Security Connector responses.", "type": "boolean" }, "description": { "description": "Description of the built-in response.", "minLength": 1, "type": "string" }, "id": { "description": "A unique identifier for each response. Use this value for any `responseId` parameters in subsequent operations.", "type": "integer" }, "name": { "description": "Name of the built-in response.", "minLength": 1, "type": "string" } }, "required": [ "name", "description", "allowedForAup", "allowedForDnsPolicy", "allowedForSecurity", "id" ], "type": "object" }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/akamai-responses.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List built-in responses", "tags": [ "Policy built-in responses" ] }, "x-akamai": { "file-path": "paths/responses.yaml", "path-info": "/responses" } }, "/securityCategories": { "get": { "description": "Returns all available predefined security categories.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-security-categories" }, "operationId": "get-security-categories", "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": [ { "description": "Risky domains", "id": 6, "name": "Risky domains", "userSelectable": false }, { "description": "File sharing", "id": 7, "name": "File sharing", "userSelectable": false }, { "description": "Other", "id": 4, "name": "Other", "userSelectable": true }, { "description": "Malware", "id": 1, "name": "Malware", "userSelectable": true }, { "description": "Phishing", "id": 2, "name": "Phishing", "userSelectable": true }, { "description": "C&C", "id": 3, "name": "C&C", "userSelectable": true }, { "description": "DNS Exfiltration", "id": 5, "name": "DNS Exfiltration", "userSelectable": true }, { "description": "Too Large", "id": 8, "name": "Too Large", "userSelectable": false }, { "description": "Broken Domain", "id": 10, "name": "Broken Domain", "userSelectable": false }, { "description": "Infrastructure", "id": 12, "name": "Infrastructure", "userSelectable": false }, { "description": "No Proxy", "id": 11, "name": "No Proxy", "userSelectable": false } ], "schema": { "description": "Lists the security category properties.", "items": { "additionalProperties": false, "properties": { "description": { "description": "Describes the security category.", "minLength": 1, "type": "string" }, "id": { "description": "Identifies the security category.", "minimum": 1, "type": "integer" }, "name": { "description": "The security category name.", "minLength": 1, "type": "string" }, "userSelectable": { "description": "Marks the category as user-selectable.", "type": "boolean" } }, "required": [ "name", "description", "id", "userSelectable" ], "type": "object" }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/security-categories.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List security category predefined configurations", "tags": [ "Policy predefined security categories" ] }, "x-akamai": { "file-path": "paths/security-categories.yaml", "path-info": "/securityCategories" } } }, "servers": [ { "url": "https://{hostname}/etp-config/v3" } ], "tags": [ { "description": "TLS certificates allow you to establish a secure connection using the public key provided by your certificate authority (CA). You can specify an Akamai-issued certificate or a customer-provisioned certificate using a trusted third-party CA.", "name": "Proxy certificates" }, { "description": "A policy is the rule set defining how SIA handles known or suspected DNS threats. You can assign a single policy to a location or multiple locations to a policy.", "name": "Policies" }, { "description": "Built-in responses are automated messages displayed to end users indicating when their activity violates a policy.", "name": "Policy built-in responses" }, { "description": "A set of default security threat categories for traffic that you can tailor to your organization's needs.", "name": "Policy predefined security categories" }, { "description": "Data loss prevention (DLP) allows SIA to identify and block sensitive or confidential data uploaded from a corporate network and transmitted to the public Internet over an HTTP or HTTPS connection. A DLP dictionary contains the regular expression patterns that are used to find this information.", "name": "DLP dictionaries" }, { "description": "The patterns used by a DLP dictionary to detect data loss.", "name": "DLP dictionary patterns" }, { "description": "The regular expressions used by a DLP dictionary to detect data loss.", "name": "DLP regexes" }, { "description": "After applying configuration changes to a site, policy, emergency list, or honeypot, you must deploy these changes to the SIA network to ensure the changes take effect. Changes typically deploy within 20-30 seconds.", "name": "Deployment configuration" }, { "description": "A collection of the configuration changes made to an existing deployment.", "name": "Deployment changes" }, { "description": "Forwards suspicious or malicious traffic to identify machines that are infected with malware, attempt to download malware, or make requests to command and control servers. They can also be used as an HTTP or DNS forwarder.", "name": "Security connectors" }, { "description": "A custom response configuration allows you to direct suspicious traffic to a machine in your network where activity is recorded. Information about the user device that made the request is captured to discover the internal IP addresses of infected machines on the corporate network.", "name": "Custom responses" }, { "description": "DNS VIPs are virtual IP addresses assigned to allow DNS to resolve the internal IP addresses to the hostnames.", "name": "DNS VIPs" }, { "description": "A collection of application settings applied to each of your properties by default.", "name": "Global settings" }, { "description": "A site is a named collection of public IP addresses that belong to a region or geographic area in your network, such as a CIDR block for an office branch or company headquarters. Use sites to compare the query's source IP with the IPs of configured sites. A site configuration must include the IP address of your Active Directory or other local DNS server used to communicate with SIA.", "name": "Sites" }, { "description": "A sub-location is a named collection of public IP addresses within a defined site. ", "name": "Sub-locations" }, { "description": "When you sign up for SIA, you receive a configuration and associated ID. This configuration contains settings for all of your sites, such as locations, policies, and quick lists. You can configure network configurations, global settings, and add or remove connectors to your base SIA configuration.", "name": "Configurations" }, { "description": "Acknowledgements contain SIA keys and the customer's original account configuration agreement.", "name": "Acknowledgments" }, { "description": "Custom error pages allow the SIA admin to customize the error page displayed in a user's browser based on the configuration policy.", "name": "Custom error pages" }, { "description": "These operations control the state of the configuration wizard process when the admin uses the wizard.", "name": "Configuration wizard" }, { "description": "These operations control the bulk log export destination and schedule configurations.", "name": "Bulk log export" }, { "description": "These operations allow the admin to assign policies based on users and groups.", "name": "User and group-based policies" }, { "description": "Enables managing client configurations. The operations include the SIA clients and network configuration along with version management and ability to activate and deactivate on demand.", "name": "Client configuration" }, { "description": "Tracks the client software versions deployed.", "name": "Client versions" }, { "description": "Tracks the devices the SIA client is installed on.", "name": "Client devices" }, { "description": "Configures network access settings for client devices.", "name": "Client network configurations" }, { "description": "Configures notifications based on the location, threat category, or report type.", "name": "Notifications" }, { "description": "A list is a set of domain and IP addresses, URLs, and file hashes that are known or suspected to be malicious for a specific category of threat.", "name": "Lists" }, { "description": "By default, each policy is configured with Akamai security lists. These security lists contain domains and IP addresses identified by Akamai as threats in the category assigned to the list. Various network security resources are used to maintain and update these lists.", "name": "Akamai built-in security lists" }, { "description": "A collection of known DNS hosts that have already been resolved by a domain.", "name": "DNS cache" }, { "description": "Enables the SIA proxy to authorize connections from the on-premises proxy in a proxy chaining configuration. This setting adds the `Proxy-Authorization` header to these connections. The `Proxy-Authorization` header contains proxy credentials that authenticate the on-premises VPN. ETP validates these credentials before it allows connections from the on-premises VPN.", "name": "VPN credentials" }, { "description": "Enables the SIA proxy to authorize connections from the on-premises proxy in a proxy chaining configuration. This setting adds the `Proxy-Authorization` header to these connections. The `Proxy-Authorization` header contains proxy credentials that authenticate the on-premises proxy. The SIA proxy validates these credentials before it allows connections from the on-premises proxy.", "name": "Proxy credentials" }, { "description": "Tenant access is used by Managed Service Providers (MSP) to restrict and create separate access for individual customers. These same settings help you delegate access within an organization.", "name": "Tenants" } ], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } }