--- updatedAt: 2026-03-01T18:19:54.000Z --- # Create a new destination This operation creates a new destination. # OpenAPI definition ```json { "components": { "securitySchemes": { "oauth_v2": { "description": "This API uses OAuth 2 with the implicit grant flow.", "flows": { "authorizationCode": { "authorizationUrl": "/api/identity/v1/oauth/authorize", "scopes": { "coblitz.co": "This scope is automatically assigned to users with the `CO` role." }, "tokenUrl": "/api/identity/v1/oauth/token" } }, "type": "oauth2" } } }, "externalDocs": { "description": "See documentation for Akamai's Aura Log Streaming API", "url": "https://techdocs.akamai.com/aura-log-streaming/reference" }, "info": { "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Destinations", "version": "v1" }, "openapi": "3.0.0", "paths": { "/destinations": { "post": { "description": "This operation creates a new destination.", "externalDocs": { "description": "See documentation for this operation in Akamai's Aura Log Streaming API", "url": "https://techdocs.akamai.com/aura-log-streaming/reference/post-destination" }, "operationId": "post-destination", "requestBody": { "content": { "application/json": { "example": { "enable": true, "hosts": [ "nyc-logs.server.com:9200", "la-logs.server.com:9201" ], "name": "kafka_destination1", "type": "KAFKA" }, "schema": { "description": "Log stream destination full schema.", "oneOf": [ { "additionalProperties": false, "description": "Kafka log stream destination create schema.", "properties": { "compression": { "description": "This sets the compression type to `GZIP`.", "enum": [ "GZIP" ], "type": "string" }, "enable": { "default": true, "description": "Enables the destination. If disabled, logs don't stream to the destination.", "type": "boolean" }, "hosts": { "description": "A set of up to four hostnames.", "items": { "maxLength": 256, "type": "string" }, "maxItems": 4, "minItems": 1, "type": "array" }, "messageFormat": { "default": "RAW", "description": "Defines the message format sent to the Kafka topic. Supports `JSON` and `RAW` formats. If not specified, `RAW` is the default.", "enum": [ "JSON", "RAW" ], "type": "string" }, "name": { "description": "The unique name for this destination.", "maxLength": 128, "minLength": 1, "type": "string" }, "type": { "description": "Reflects the type of destination, for which the only available value is `KAFKA`.", "enum": [ "KAFKA" ], "readOnly": true, "type": "string" } }, "required": [ "name", "type", "hosts" ], "title": "Kafka destination", "type": "object", "x-akamai": { "file-path": "schemas/kafka-destination.create.yaml" } }, { "additionalProperties": false, "description": "Specifies a Hydrolix destination for streamed logs.", "properties": { "authorization": { "oneOf": [ { "additionalProperties": false, "description": "`BASIC` authorization encodes and sends the provided `username` and `password` in an HTTP Basic `Authorization` header.", "properties": { "type": { "description": "Enumerated type for the authorization structure, in this case `BASIC`.", "enum": [ "BASIC" ], "type": "string" } }, "required": [ "type" ], "title": "Basic Authorization", "type": "object" }, { "additionalProperties": false, "description": "`BEARER` authorization presents the `username` and `password` credentials in exchange for a Hydrolix bearer token.", "properties": { "authorizationServerHostname": { "description": "For bearer tokens fetched periodically by the service node, use the destination hostname for the token requests. If the authorization server is different from the destination host, you can specify it using the `authorizationServerHostname`.", "maxLength": 256, "type": "string" }, "tokenEndpoint": { "default": "/config/v1/login", "description": "For bearer tokens fetched periodically by the service node, the Hydrolix API defines the destination URI and defaults to `/config/v1/login`. If the bearer token endpoint is different from the specified Hydrolix authentication API, you can redefine it using the `tokenEndpoint`.", "maxLength": 2048, "type": "string" }, "type": { "description": "Enumerated type for the authorization structure, in this case `BEARER`.", "enum": [ "BEARER" ], "type": "string" } }, "required": [ "type" ], "title": "Bearer Authorization", "type": "object" } ] }, "compression": { "description": "This sets the compression type to `GZIP`.", "enum": [ "GZIP" ], "type": "string" }, "dateFormat": { "default": "ISO8601", "description": "This defaults to the text readable `ISO8601` format, but can also be sent as an `EPOCH` or `DOUBLE` time value. Specifying `dateKey` defines the additional date or timestamp format sent in the log object. If you don't specify the value of `dateKey`, this setting has no effect on the log and no additional Date key or value is sent.", "enum": [ "ISO8601", "EPOCH", "DOUBLE" ], "type": "string" }, "dateKey": { "description": "Log indexing uses timestamps in each of the logs. If the time requires an additional key or format, the `dateKey` selects the key for the additional timestamp. If not specified, no additional timestamp is sent in the log.", "type": "string" }, "enable": { "default": true, "description": "Enables the destination. If disabled, logs don't stream to the destination.", "type": "boolean" }, "hosts": { "description": "Hostname of a Hydrolix destination used in the streaming POST request URL. It can include an optional port, otherwise it uses the default port, either 80 or 443.", "items": { "maxLength": 256, "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" }, "logPostUri": { "default": "/ingest/event", "description": "URI path endpoint in HTTP request sent to Hydrolix. Hydrolix defined the path for log streaming as `/ingest/event` but it may be necessary to change this value if the endpoint URI changes.", "maxLength": 2048, "type": "string" }, "messageFormat": { "default": "JSON_LINES", "description": "Defines the HTTP POST request body message format sent to the Hydrolix endpoint. It defaults to `JSON_LINES` which is equivalent to NDJSON, where each line in the body is a separate JSON object containing one log line. If set to `JSON`, the log messages are sent in a JSON array. If set to `RAW`, raw log messages are sent.", "enum": [ "JSON_LINES", "JSON", "RAW" ], "type": "string" }, "name": { "description": "A name that uniquely identifies the destination.", "maxLength": 128, "minLength": 1, "type": "string" }, "tokenHeaderName": { "description": "The header that indicates the table token for stream POST authentication. This value defaults to `x-hdx-token` as defined at the Hydrolix endpoint, but you can redefine it if necessary. The token value defined in the stream configuration `hdxAuthToken` is set as this header value.", "maxLength": 40, "type": "string" }, "type": { "description": "Reflects the type of destination, for which the only available value is `HYDROLIX`.", "enum": [ "HYDROLIX" ], "readOnly": true, "type": "string" } }, "required": [ "name", "type", "hosts", "authorization" ], "title": "Hydrolix destination", "type": "object", "x-akamai": { "file-path": "schemas/hydrolix-destination.create.yaml" } }, { "additionalProperties": false, "description": "Specifies a Loki destination for streamed logs.", "properties": { "authorization": { "oneOf": [ { "additionalProperties": false, "description": "`BASIC` authorization encodes and sends the provided `username` and `password` in an HTTP Basic `Authorization` header.", "properties": { "type": { "description": "Specifies `BASIC` for the authorization structure.", "enum": [ "BASIC" ], "type": "string" } }, "required": [ "type" ], "title": "Basic Authorization", "type": "object" }, { "additionalProperties": false, "description": "Use `TOKEN` authorization as a static bearer token for cloud based grafana-loki-log destinations. An HTTP `Authorization` header provides the configured token credentials.", "properties": { "type": { "description": "Specifies `TOKEN` for the authorization structure.", "enum": [ "TOKEN" ], "type": "string" } }, "required": [ "type" ], "title": "Token Authorization", "type": "object" } ] }, "compression": { "description": "This sets the compression type to `GZIP`.", "enum": [ "GZIP" ], "type": "string" }, "destinationId": { "description": "The unique identifier for this destination object.", "minimum": 1, "readOnly": true, "type": "integer" }, "enable": { "default": true, "description": "Enables the destination. If disabled, logs don't stream to the destination.", "type": "boolean" }, "hosts": { "description": "The Loki destination's hostname used in the streaming POST request URL. It can include an optional port, otherwise it uses the default 80 or 443 port. For Loki destinations that use the default 3100 port, the hostname should include that port number. Omit the port number for Loki applications fronted by an nginx proxy to provide client authentication using HTTPS on port 443. ", "items": { "maxLength": 256, "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" }, "logPostUri": { "default": "/loki/api/v1/push", "description": "The URL path endpoint sent in an HTTP request to Loki. It's the default path for Loki log streaming, but it may be necessary to change this value if the endpoint changes.", "maxLength": 2048, "type": "string" }, "messageFormat": { "default": "JSON", "description": "Defines the message format sent to the Loki endpoint. Supports `JSON` and `RAW` formats. If not specified, `JSON` is the default.", "enum": [ "JSON", "RAW" ], "type": "string" }, "name": { "description": "A name that uniquely identifies the destination.", "maxLength": 128, "minLength": 1, "type": "string" }, "tenantId": { "description": "Normally not defined for single tenant Loki deployments. If a cloud-based Grafana Loki database serves multiple log sources, use the `tenantId` as a `secret-id` to ensure tenants can view logs only in their own domain. The log POST request sends the `tenantId` in an `X-Scope-OrgID` request header. Any query must include it for logs posted that include the header.", "type": "string" }, "type": { "description": "Reflects the type of destination, `LOKI` in this case.", "enum": [ "LOKI" ], "readOnly": true, "type": "string" } }, "required": [ "destinationId", "name", "type", "hosts" ], "title": "Loki estination", "type": "object", "x-akamai": { "file-path": "schemas/loki-destination.create.yaml" } } ], "x-akamai": { "file-path": "schemas/destination.create.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "destinationId": 1, "enable": true, "hosts": [ "nyc-logs.server.com:9200", "la-logs.server.com:9201" ], "name": "kafka_destination1", "type": "KAFKA" }, "schema": { "description": "Log stream destination full schema.", "oneOf": [ { "additionalProperties": false, "description": "Specifies a Kafka collection location for streamed logs.", "properties": { "compression": { "description": "This sets the compression type to `GZIP`.", "enum": [ "GZIP" ], "type": "string" }, "destinationId": { "description": "The unique identifier for this destination object.", "minimum": 1, "readOnly": true, "type": "integer" }, "enable": { "default": true, "description": "Enables the destination. If disabled, logs don't stream to the destination.", "type": "boolean" }, "hosts": { "description": "A set of up to four hostnames.", "items": { "maxLength": 256, "type": "string" }, "maxItems": 4, "minItems": 1, "type": "array" }, "messageFormat": { "default": "RAW", "description": "Defines the message format sent to the Kafka topic. Supports `JSON` and `RAW` formats. If not specified, `RAW` is the default.", "enum": [ "JSON", "RAW" ], "type": "string" }, "name": { "description": "A name that uniquely identifies the destination.", "maxLength": 128, "minLength": 1, "type": "string" }, "type": { "description": "Reflects the type of destination, for which the only available value is `KAFKA`.", "enum": [ "KAFKA" ], "readOnly": true, "type": "string" } }, "required": [ "destinationId", "name", "type", "hosts" ], "title": "Kafka destination", "type": "object", "x-akamai": { "file-path": "schemas/kafka-destination.full.yaml" } }, { "additionalProperties": false, "description": "Specifies a Hydrolix destination for streamed logs.", "properties": { "authorization": { "oneOf": [ { "additionalProperties": false, "description": "`BASIC` authorization encodes and sends the provided `username` and `password` in an HTTP Basic `Authorization` header.", "properties": { "type": { "description": "Enumerated type for the authorization structure, in this case `BASIC`.", "enum": [ "BASIC" ], "type": "string" } }, "required": [ "type" ], "title": "Basic Authorization", "type": "object" }, { "additionalProperties": false, "description": "`BEARER` authorization presents the `username` and `password` credentials in exchange for a Hydrolix bearer token.", "properties": { "authorizationServerHostname": { "description": "For bearer tokens fetched periodically by the service node, use the destination hostname for the token requests. If the authorization server is different from the destination host, you can specify it using the `authorizationServerHostname`.", "maxLength": 256, "type": "string" }, "tokenEndpoint": { "default": "/config/v1/login", "description": "For bearer tokens fetched periodically by the service node, the Hydrolix API defines the destination URI and defaults to `/config/v1/login`. If the bearer token endpoint is different from the specified Hydrolix authentication API, you can redefine it using the `tokenEndpoint`.", "maxLength": 2048, "type": "string" }, "type": { "description": "Enumerated type for the authorization structure, in this case `BEARER`.", "enum": [ "BEARER" ], "type": "string" } }, "required": [ "type" ], "title": "Bearer Authorization", "type": "object" } ] }, "compression": { "description": "This sets the compression type to `GZIP`.", "enum": [ "GZIP" ], "type": "string" }, "dateFormat": { "default": "ISO8601", "description": "This defaults to the text readable `ISO8601` format, but can also be sent as an `EPOCH` or `DOUBLE` time value. Specifying `dateKey` defines the additional date or timestamp format sent in the log object. If you don't specify the value of `dateKey`, this setting has no effect on the log and no additional Date key or value is sent.", "enum": [ "ISO8601", "EPOCH", "DOUBLE" ], "type": "string" }, "dateKey": { "description": "Log indexing uses timestamps in each of the logs. If the time requires an additional key or format, the `dateKey` selects the key for the additional timestamp. If not specified, no additional timestamp is sent in the log.", "type": "string" }, "destinationId": { "description": "The unique identifier for this destination object.", "minimum": 1, "readOnly": true, "type": "integer" }, "enable": { "default": true, "description": "Enables the destination. If disabled, logs don't stream to the destination.", "type": "boolean" }, "hosts": { "description": "Hostname of a Hydrolix destination used in the streaming POST request URL. It can include an optional port, otherwise it uses the default port, either 80 or 443.", "items": { "maxLength": 256, "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" }, "logPostUri": { "default": "/ingest/event", "description": "URI path endpoint in HTTP request sent to Hydrolix. Hydrolix defined the path for log streaming as `/ingest/event` but it may be necessary to change this value if the endpoint URI changes.", "maxLength": 2048, "type": "string" }, "messageFormat": { "default": "JSON_LINES", "description": "Defines the HTTP POST request body message format sent to the Hydrolix endpoint. It defaults to `JSON_LINES` which is equivalent to NDJSON, where each line in the body is a separate JSON object containing one log line. If set to `JSON`, the log messages are sent in a JSON array. If set to `RAW`, raw log messages are sent.", "enum": [ "JSON_LINES", "JSON", "RAW" ], "type": "string" }, "name": { "description": "A name that uniquely identifies the destination.", "maxLength": 128, "minLength": 1, "type": "string" }, "tokenHeaderName": { "description": "The header that indicates the table token for stream POST authentication. This value defaults to `x-hdx-token` as defined at the Hydrolix endpoint, but you can redefine it if necessary. The token value defined in the stream configuration `hdxAuthToken` is set as this header value.", "maxLength": 40, "type": "string" }, "type": { "description": "Reflects the type of destination, for which the only available value is `HYDROLIX`.", "enum": [ "HYDROLIX" ], "readOnly": true, "type": "string" } }, "required": [ "destinationId", "name", "type", "hosts", "authorization" ], "title": "Hydrolix destination", "type": "object", "x-akamai": { "file-path": "schemas/hydrolix-destination.full.yaml" } }, { "additionalProperties": false, "description": "Specifies a Loki destination for streamed logs.", "properties": { "authorization": { "oneOf": [ { "additionalProperties": false, "description": "`BASIC` authorization encodes and sends the provided `username` and `password` in an HTTP Basic `Authorization` header.", "properties": { "type": { "description": "Specifies `BASIC` for the authorization structure.", "enum": [ "BASIC" ], "type": "string" } }, "required": [ "type" ], "title": "Basic Authorization", "type": "object" }, { "additionalProperties": false, "description": "Use `TOKEN` authorization as a static bearer token for cloud based grafana-loki-log destinations. An HTTP `Authorization` header provides the configured token credentials.", "properties": { "type": { "description": "Specifies `TOKEN` for the authorization structure.", "enum": [ "TOKEN" ], "type": "string" } }, "required": [ "type" ], "title": "Token Authorization", "type": "object" } ] }, "compression": { "description": "This sets the compression type to `GZIP`.", "enum": [ "GZIP" ], "type": "string" }, "destinationId": { "description": "The unique identifier for this destination object.", "minimum": 1, "readOnly": true, "type": "integer" }, "enable": { "default": true, "description": "Enables the destination. If disabled, logs don't stream to the destination.", "type": "boolean" }, "hosts": { "description": "The Loki destination's hostname used in the streaming POST request URL. It can include an optional port, otherwise it uses the default 80 or 443 port. For Loki destinations that use the default 3100 port, the hostname should include that port number. Omit the port number for Loki applications fronted by an nginx proxy to provide client authentication using HTTPS on port 443. ", "items": { "maxLength": 256, "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" }, "logPostUri": { "default": "/loki/api/v1/push", "description": "The URL path endpoint sent in an HTTP request to Loki. It's the default path for Loki log streaming, but it may be necessary to change this value if the endpoint changes.", "maxLength": 2048, "type": "string" }, "messageFormat": { "default": "JSON", "description": "Defines the message format sent to the Loki endpoint. Supports `JSON` and `RAW` formats. If not specified, `JSON` is the default.", "enum": [ "JSON", "RAW" ], "type": "string" }, "name": { "description": "A name that uniquely identifies the destination.", "maxLength": 128, "minLength": 1, "type": "string" }, "tenantId": { "description": "Normally not defined for single tenant Loki deployments. If a cloud-based Grafana Loki database serves multiple log sources, use the `tenantId` as a `secret-id` to ensure tenants can view logs only in their own domain. The log POST request sends the `tenantId` in an `X-Scope-OrgID` request header. Any query must include it for logs posted that include the header.", "type": "string" }, "type": { "description": "Reflects the type of destination, `LOKI` in this case.", "enum": [ "LOKI" ], "readOnly": true, "type": "string" } }, "required": [ "destinationId", "name", "type", "hosts" ], "title": "Loki destination", "type": "object", "x-akamai": { "file-path": "schemas/loki-destination.full.yaml" } } ], "x-akamai": { "file-path": "schemas/destination.read-detailed.yaml" } } } }, "description": "The response shows the newly created destination, which is available at the `Location` header's URL.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "description": "A URL to navigate to the newly created resource.", "schema": { "example": "https://akzz-xxxx-xxxx.luna.akamaiapis.net/api/log-streaming/v1/destinations/1", "type": "string" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "Constraint violations were detected", "instance": "https://akzz-xxxx-xxxx.luna.akamaiapis.net/api/log-streaming/v1/destinations#7284f092-f2f1-4131-a9dc-f8a5b7b6980f", "title": "The request entity is invalid", "type": "https://akzz-xxxx-xxxx.luna.akamaiapis.net/api/log-streaming/errors#core.constraint-violation", "violations": [ { "detail": "may not be null", "property": "#/name", "type": "https://akzz-xxxx-xxxx.luna.akamaiapis.net/api/log-streaming/errors#core.not-null-violation" } ] }, "schema": { "anyOf": [ { "allOf": [ { "additionalProperties": true, "description": "The base HTTP problem type.", "properties": { "detail": { "description": "A description of the class of problem that occurred.", "type": "string" }, "instance": { "description": "A unique identifier of a problem instance.", "type": "string" }, "status": { "description": "The identified HTTP status code.", "type": "integer" }, "title": { "description": "Title of the class of problem that occurred.", "type": "string" }, "type": { "description": "A URI describing which type of HTTP problem occurred.", "type": "string" } }, "required": [ "type", "instance" ] }, { "additionalProperties": true, "properties": { "pathParamName": { "description": "The path parameter with the problem.", "type": "string" }, "pathParamValue": { "description": "The value supplied in the request.", "type": "string" } }, "required": [ "pathParamName", "pathParamValue" ] } ], "description": "Invalid path parameter HTTP problem. This indicates the server can't process a path parameter due to incorrect type or formatting.", "x-akamai": { "file-path": "schemas/invalid-path-param-problem.yaml" } }, { "allOf": [ { "additionalProperties": true, "description": "The base HTTP problem type.", "properties": { "detail": { "description": "A description of the class of problem that occurred.", "type": "string" }, "instance": { "description": "A unique identifier of a problem instance.", "type": "string" }, "status": { "description": "The identified HTTP status code.", "type": "integer" }, "title": { "description": "Title of the class of problem that occurred.", "type": "string" }, "type": { "description": "A URI describing which type of HTTP problem occurred.", "type": "string" } }, "required": [ "type", "instance" ] }, { "additionalProperties": true, "properties": { "property": { "description": "The field with the problem.", "type": "string" } }, "required": [ "property" ] } ], "description": "JSON mapping HTTP problem.", "x-akamai": { "file-path": "schemas/json-mapping-problem.yaml" } }, { "allOf": [ { "additionalProperties": true, "description": "The base HTTP problem type.", "properties": { "detail": { "description": "A description of the class of problem that occurred.", "type": "string" }, "instance": { "description": "A unique identifier of a problem instance.", "type": "string" }, "status": { "description": "The identified HTTP status code.", "type": "integer" }, "title": { "description": "Title of the class of problem that occurred.", "type": "string" }, "type": { "description": "A URI describing which type of HTTP problem occurred.", "type": "string" } }, "required": [ "type", "instance" ] }, { "additionalProperties": true, "properties": { "pathParamName": { "description": "The path parameter with the problem.", "type": "string" }, "pathParamValue": { "description": "The value supplied in the request.", "type": "string" } }, "required": [ "pathParamName", "pathParamValue" ] } ], "description": "Invalid path parameter HTTP problem. This indicates the server can't process a path parameter due to incorrect type or formatting.", "x-akamai": { "file-path": "schemas/invalid-path-param-problem.yaml" } }, { "allOf": [ { "additionalProperties": true, "description": "The base HTTP problem type.", "properties": { "detail": { "description": "A description of the class of problem that occurred.", "type": "string" }, "instance": { "description": "A unique identifier of a problem instance.", "type": "string" }, "status": { "description": "The identified HTTP status code.", "type": "integer" }, "title": { "description": "Title of the class of problem that occurred.", "type": "string" }, "type": { "description": "A URI describing which type of HTTP problem occurred.", "type": "string" } }, "required": [ "type", "instance" ] }, { "additionalProperties": true, "properties": { "property": { "description": "The name of the entity field that needs to match the URI parameter.", "type": "string" }, "propertyValue": { "description": "The supplied value of the field.", "oneOf": [ { "title": "String value", "type": "string" }, { "title": "Number value", "type": "number" }, { "title": "Integer value", "type": "integer" }, { "title": "Boolean value", "type": "boolean" } ] }, "uriParameterName": { "description": "The name of the URI parameter.", "type": "string" }, "uriParameterValue": { "description": "The supplied value of the URI parameter.", "type": "string" } }, "required": [ "uriParameterName", "uriParameterValue", "property", "propertyValue" ] } ], "description": "A path parameter or entity field mismatch HTTP problem. In some situations, a URI references an entity and also includes its identifier. If the identifier is also present in the body and the two don’t match, this error indicates that the intended operation is unclear.", "x-akamai": { "file-path": "schemas/path-param-field-mismatch-problem.yaml" } }, { "allOf": [ { "additionalProperties": true, "description": "The base HTTP problem type.", "properties": { "detail": { "description": "A description of the class of problem that occurred.", "type": "string" }, "instance": { "description": "A unique identifier of a problem instance.", "type": "string" }, "status": { "description": "The identified HTTP status code.", "type": "integer" }, "title": { "description": "Title of the class of problem that occurred.", "type": "string" }, "type": { "description": "A URI describing which type of HTTP problem occurred.", "type": "string" } }, "required": [ "type", "instance" ] }, { "additionalProperties": true, "properties": { "parameter": { "description": "The parameter that's in the error.", "type": "string" }, "value": { "description": "The provided value.", "type": "string" } }, "required": [ "parameter", "value" ] } ], "description": "Invalid parameter HTTP problem.", "x-akamai": { "file-path": "schemas/invalid-parameter-problem.yaml" } }, { "allOf": [ { "additionalProperties": true, "description": "The base HTTP problem type.", "properties": { "detail": { "description": "A description of the class of problem that occurred.", "type": "string" }, "instance": { "description": "A unique identifier of a problem instance.", "type": "string" }, "status": { "description": "The identified HTTP status code.", "type": "integer" }, "title": { "description": "Title of the class of problem that occurred.", "type": "string" }, "type": { "description": "A URI describing which type of HTTP problem occurred.", "type": "string" } }, "required": [ "type", "instance" ] }, { "additionalProperties": true, "properties": { "violations": { "description": "Violations detected in the request.", "items": { "anyOf": [ { "allOf": [ { "additionalProperties": true, "properties": { "detail": { "description": "Description of the problem.", "type": "string" }, "property": { "description": "The request field that caused a violation.", "type": "string" }, "type": { "description": "Uniquely identifies each error case.", "type": "string" }, "value": { "description": "The value in the request that caused a violation.", "oneOf": [ { "title": "String value", "type": "string" }, { "title": "Number value", "type": "number" }, { "title": "Integer value", "type": "integer" }, { "title": "Boolean value", "type": "boolean" }, { "title": "Object value", "type": "object" } ] } }, "required": [ "property", "type" ] }, { "title": "Not-null violation", "type": "object" } ] }, { "allOf": [ { "additionalProperties": true, "properties": { "detail": { "description": "Description of the problem.", "type": "string" }, "property": { "description": "The request field that caused a violation.", "type": "string" }, "type": { "description": "Uniquely identifies each error case.", "type": "string" }, "value": { "description": "The value in the request that caused a violation.", "oneOf": [ { "title": "String value", "type": "string" }, { "title": "Number value", "type": "number" }, { "title": "Integer value", "type": "integer" }, { "title": "Boolean value", "type": "boolean" }, { "title": "Object value", "type": "object" } ] } }, "required": [ "property", "type" ] }, { "additionalProperties": true, "properties": { "min": { "description": "The minimum allowable value for the given property.", "type": "integer" } }, "required": [ "min" ], "title": "Minimum violation" } ] }, { "allOf": [ { "additionalProperties": true, "properties": { "detail": { "description": "Description of the problem.", "type": "string" }, "property": { "description": "The request field that caused a violation.", "type": "string" }, "type": { "description": "Uniquely identifies each error case.", "type": "string" }, "value": { "description": "The value in the request that caused a violation.", "oneOf": [ { "title": "String value", "type": "string" }, { "title": "Number value", "type": "number" }, { "title": "Integer value", "type": "integer" }, { "title": "Boolean value", "type": "boolean" }, { "title": "Object value", "type": "object" } ] } }, "required": [ "property", "type" ] }, { "additionalProperties": true, "properties": { "max": { "description": "The maximum allowable value for the given property. ", "type": "integer" } }, "required": [ "max" ], "title": "Maximum violation" } ] }, { "allOf": [ { "additionalProperties": true, "properties": { "detail": { "description": "Description of the problem.", "type": "string" }, "property": { "description": "The request field that caused a violation.", "type": "string" }, "type": { "description": "Uniquely identifies each error case.", "type": "string" }, "value": { "description": "The value in the request that caused a violation.", "oneOf": [ { "title": "String value", "type": "string" }, { "title": "Number value", "type": "number" }, { "title": "Integer value", "type": "integer" }, { "title": "Boolean value", "type": "boolean" }, { "title": "Object value", "type": "object" } ] } }, "required": [ "property", "type" ] }, { "additionalProperties": true, "properties": { "size": { "description": "The maximum allowable size for the given property. For strings this is the string length.", "type": "integer" } }, "required": [ "size" ], "title": "Size violation" } ] }, { "allOf": [ { "additionalProperties": true, "properties": { "detail": { "description": "Description of the problem.", "type": "string" }, "property": { "description": "The request field that caused a violation.", "type": "string" }, "type": { "description": "Uniquely identifies each error case.", "type": "string" }, "value": { "description": "The value in the request that caused a violation.", "oneOf": [ { "title": "String value", "type": "string" }, { "title": "Number value", "type": "number" }, { "title": "Integer value", "type": "integer" }, { "title": "Boolean value", "type": "boolean" }, { "title": "Object value", "type": "object" } ] } }, "required": [ "property", "type" ] }, { "additionalProperties": true, "properties": { "pattern": { "description": "The allowable pattern for a property. This pattern is usually be a regular expression.", "type": "string" } }, "required": [ "pattern" ], "title": "Pattern violation" } ] }, { "allOf": [ { "additionalProperties": true, "properties": { "detail": { "description": "Description of the problem.", "type": "string" }, "property": { "description": "The request field that caused a violation.", "type": "string" }, "type": { "description": "Uniquely identifies each error case.", "type": "string" }, "value": { "description": "The value in the request that caused a violation.", "oneOf": [ { "title": "String value", "type": "string" }, { "title": "Number value", "type": "number" }, { "title": "Integer value", "type": "integer" }, { "title": "Boolean value", "type": "boolean" }, { "title": "Object value", "type": "object" } ] } }, "required": [ "property", "type" ] }, { "additionalProperties": true, "properties": { "requiredValue": { "description": "Specifies the allowable condition value for a property.", "type": "boolean" } }, "required": [ "requiredValue" ], "title": "Condition violation" } ] } ] }, "type": "array" } } } ], "description": "Schema for constraint violation problems", "x-akamai": { "file-path": "schemas/constraint-violation-problem.yaml" } } ], "description": "Super type to enumerate 400 class errors.", "x-akamai": { "file-path": "schemas/bad-request-problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/aura-log-streaming/reference/400)", "x-akamai": { "file-path": "errors/bad-request-problem.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "The principal does not have authority to access the requested entity", "instance": "https://akzz-xxxx-xxxx.luna.akamaiapis.net/api/log-streaming/v1/destinations#81e98f22da7d22de", "title": "The principal is not authorized to access the requested resource", "type": "https://akzz-xxxx-xxxx.luna.akamaiapis.net/api/log-streaming/errors#core.access-denied" }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The base HTTP problem type.", "properties": { "detail": { "description": "A description of the class of problem that occurred.", "type": "string" }, "instance": { "description": "A unique identifier of a problem instance.", "type": "string" }, "status": { "description": "The identified HTTP status code.", "type": "integer" }, "title": { "description": "Title of the class of problem that occurred.", "type": "string" }, "type": { "description": "A URI describing which type of HTTP problem occurred.", "type": "string" } }, "required": [ "type", "instance" ] }, { "additionalProperties": true, "properties": { "entity": { "additionalProperties": false, "description": "Summarizes an entity involved in a problem.", "properties": { "entityHref": { "description": "A URL pointing to the entity.", "type": "string" }, "entityId": { "description": "The identifier of the entity.", "type": "integer" }, "entityName": { "description": "The entity name, if provided by the entity type.", "type": "string" }, "entityType": { "description": "The name of the entity type.", "type": "string" } }, "required": [ "entityType", "entityId", "entityHref" ] }, "permission": { "description": "The permission needed to access the entity.", "type": "string" } } } ], "description": "Unauthorized access HTTP problem.", "x-akamai": { "file-path": "schemas/unauthorized-access-problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/aura-log-streaming/reference/403)", "x-akamai": { "file-path": "errors/unauthorized-problem.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "conflictingEntity": { "entityHref": "https://akzz-xxxx-xxxx.luna.akamaiapis.net/api/log-streaming/v1/destinations/1", "entityId": "1", "entityType": "Destination" }, "conflictingProperty": "#/name", "conflictingValue": "kafka", "detail": "An entity with property 'name' of 'kafka' already exists", "instance": "https://akzz-xxxx-xxxx.luna.akamaiapis.net/api/log-streaming/v1/destinations#a4e84e37-ec37-4a13-83d7-ba1d75a36029", "title": "The request has conflicting properties with existing configuration", "type": "https://akzz-xxxx-xxxx.luna.akamaiapis.net/api/log-streaming/errors#core.entity-property-conflict" }, "schema": { "description": "Super type to enumerate 409 class errors.", "oneOf": [ { "allOf": [ { "additionalProperties": true, "description": "The base HTTP problem type.", "properties": { "detail": { "description": "A description of the class of problem that occurred.", "type": "string" }, "instance": { "description": "A unique identifier of a problem instance.", "type": "string" }, "status": { "description": "The identified HTTP status code.", "type": "integer" }, "title": { "description": "Title of the class of problem that occurred.", "type": "string" }, "type": { "description": "A URI describing which type of HTTP problem occurred.", "type": "string" } }, "required": [ "type", "instance" ] }, { "additionalProperties": true, "properties": { "conflictingEntity": { "additionalProperties": false, "description": "Summarizes an entity involved in a problem.", "properties": { "entityHref": { "description": "A URL pointing to the entity.", "type": "string" }, "entityId": { "description": "The identifier of the entity.", "type": "integer" }, "entityName": { "description": "The entity name, if provided by the entity type.", "type": "string" }, "entityType": { "description": "The name of the entity type.", "type": "string" } }, "required": [ "entityType", "entityId", "entityHref" ] }, "conflictingProperty": { "description": "The field with the problem.", "type": "string" }, "conflictingValue": { "description": "The supplied value.", "oneOf": [ { "title": "String value", "type": "string" }, { "title": "Number value", "type": "number" }, { "title": "Integer value", "type": "integer" }, { "title": "Boolean value", "type": "boolean" }, { "title": "Object value", "type": "object" } ] } }, "required": [ "conflictingProperty", "conflictingValue", "conflictingEntity" ] } ], "description": "Entity property conflict HTTP problem. This indicates a property set on an entity that causes a conflict with an existing entity, for example when assigning duplicate surrogate identifiers.", "x-akamai": { "file-path": "schemas/entity-property-conflict-problem.yaml" } }, { "allOf": [ { "additionalProperties": true, "description": "The base HTTP problem type.", "properties": { "detail": { "description": "A description of the class of problem that occurred.", "type": "string" }, "instance": { "description": "A unique identifier of a problem instance.", "type": "string" }, "status": { "description": "The identified HTTP status code.", "type": "integer" }, "title": { "description": "Title of the class of problem that occurred.", "type": "string" }, "type": { "description": "A URI describing which type of HTTP problem occurred.", "type": "string" } }, "required": [ "type", "instance" ] }, { "additionalProperties": true, "properties": { "referencedEntity": { "additionalProperties": false, "description": "Summarizes an entity involved in a problem.", "properties": { "entityHref": { "description": "A URL pointing to the entity.", "type": "string" }, "entityId": { "description": "The identifier of the entity.", "type": "integer" }, "entityName": { "description": "The entity name, if provided by the entity type.", "type": "string" }, "entityType": { "description": "The name of the entity type.", "type": "string" } }, "required": [ "entityType", "entityId", "entityHref" ] }, "referringEntities": { "description": "Summarizes the entities involved in a problem.", "items": { "additionalProperties": false, "description": "Summarizes an entity involved in a problem.", "properties": { "entityHref": { "description": "A URL pointing to the entity.", "type": "string" }, "entityId": { "description": "The identifier of the entity.", "type": "integer" }, "entityName": { "description": "The entity name, if provided by the entity type.", "type": "string" }, "entityType": { "description": "The name of the entity type.", "type": "string" } }, "required": [ "entityType", "entityId", "entityHref" ] }, "type": "array" } }, "required": [ "referencedEntity", "referringEntities" ] } ], "description": "Entity referenced HTTP problem. This indicates an attempt to delete an entity that other entities are referring to, where removing the reference wouldn't lead to a valid state.", "x-akamai": { "file-path": "schemas/entity-referenced-problem.yaml" } }, { "allOf": [ { "additionalProperties": true, "description": "The base HTTP problem type.", "properties": { "detail": { "description": "A description of the class of problem that occurred.", "type": "string" }, "instance": { "description": "A unique identifier of a problem instance.", "type": "string" }, "status": { "description": "The identified HTTP status code.", "type": "integer" }, "title": { "description": "Title of the class of problem that occurred.", "type": "string" }, "type": { "description": "A URI describing which type of HTTP problem occurred.", "type": "string" } }, "required": [ "type", "instance" ] }, { "additionalProperties": true, "properties": { "referencedId": { "description": "The referenced object.", "type": "integer" }, "referencedType": { "description": "The referenced object's type.", "type": "string" } }, "type": "object" } ], "description": "Non-existent reference HTTP problem. It indicates a mutable operation attempting to refer to a nonexistent resource.", "x-akamai": { "file-path": "schemas/non-existent-reference-problem.yaml" } } ], "x-akamai": { "file-path": "schemas/conflict-problem.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/aura-log-streaming/reference/409)", "x-akamai": { "file-path": "errors/conflict-problem.yaml" } } }, "security": [ { "oauth_v2": [ "coblitz.co" ] } ], "summary": "Create a new destination", "tags": [ "Destinations" ] } } }, "servers": [ { "url": "https://{hostname}/api/log-streaming/v1" } ], "x-akamai": { "auth-type": "OAUTH", "file-path": "destinations.yaml", "schemaRefTypeNameHints": { "schemas/destination-security.read.yaml": "destination-security.read", "schemas/destination-security.update.yaml": "destination-security.update", "schemas/destination.collection.yaml": "destination.collection", "schemas/destination.create.yaml": "destination.create", "schemas/destination.read-detailed.yaml": "destination.read-detailed", "schemas/destination.read-summary.yaml": "destination.read-summary", "schemas/destination.update.yaml": "destination.update", "schemas/token-credentials.read.yaml": "token-credentials.read", "schemas/token-credentials.update.yaml": "token-credentials.update", "schemas/user-credentials.read.yaml": "user-credentials.read", "schemas/user-credentials.update.yaml": "user-credentials.update" } }, "x-readme": { "samples-languages": [ "curl", "python", "node" ], "explorer-enabled": true, "proxy-enabled": true } } ``` # Sibling pages * [List destinations](https://techdocs.akamai.com/aura-log-streaming/reference/get-destinations.md) * [Get a destination](https://techdocs.akamai.com/aura-log-streaming/reference/get-destination.md) * [Update a destination](https://techdocs.akamai.com/aura-log-streaming/reference/put-destination.md) * [Delete a destination](https://techdocs.akamai.com/aura-log-streaming/reference/delete-destination.md)