Documentation Powered by ReDoc

orb-sinks (1.0.0)

Download OpenAPI specification:Download

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

sink

List current Sinks

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

Size of the subset to retrieve.

offset
integer >= 0
Default: 0

Number of items to skip during retrieval.

name
string

Name filter. Filtering is performed as a case-insensitive partial match.

order
string
Default: "id"
Enum: "name" "id"

Order type.

dir
string
Default: "desc"
Enum: "asc" "desc"

Order direction.

tags
object
Example: tags={"key":"value"}

Tags filter. Filtering is performed as a case-insensitive partial key value match.

header Parameters
Authorization
required
any

User's access token (bearer auth).

Responses

Response samples

Content type
application/json
{
  • "sinks": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Create a new Sink

header Parameters
Authorization
required
any

User's access token (bearer auth).

Request Body schema: application/json

JSON-formatted document describing the new Sink configuration

One of
name
required
string

A unique name label

description
string

User description of this Sink

tags
object

User defined key/values for organization and searching

backend
required
string

The sink backend to use. Must match a backend from /features/sinks. Cannot change once created.

config
required
object

Object representing backend specific configuration information

Responses

Request samples

Content type
application/json
Example
SinkCreateReqSchema
SinkCreateReqSchema
SinkCreateReqV2Schema
{
  • "name": "my-prom-sink",
  • "description": "An example prometheus sink",
  • "tags": {
    },
  • "backend": "prometheus",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "my-prom-sink",
  • "description": "An example prometheus sink",
  • "tags": {
    },
  • "state": "active",
  • "error": "string",
  • "backend": "prometheus",
  • "config": {
    },
  • "config_data": {
    },
  • "format": "yaml",
  • "ts_created": "2019-08-24T14:15:22Z"
}

Get an existing Sink configuration

path Parameters
id
required
string <uuid>

Unique Sink identifier.

header Parameters
Authorization
required
any

User's access token (bearer auth).

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "my-prom-sink",
  • "description": "An example prometheus sink",
  • "tags": {
    },
  • "state": "active",
  • "error": "string",
  • "backend": "prometheus",
  • "config": {
    },
  • "config_data": {
    },
  • "format": "yaml",
  • "ts_created": "2019-08-24T14:15:22Z"
}

Update an existing Sink configuration

path Parameters
id
required
string <uuid>

Unique Sink identifier.

header Parameters
Authorization
required
any

User's access token (bearer auth).

Request Body schema: application/json

JSON-formatted document describing the updated Sink configuration

name
string

A unique name label

description
string

User description of this Sink

tags
object

User defined key/values for organization and searching

config
object

Object representing backend specific configuration information

Responses

Request samples

Content type
application/json
{
  • "name": "my-prom-sink",
  • "description": "An example prometheus sink",
  • "tags": {
    },
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "my-prom-sink",
  • "description": "An example prometheus sink",
  • "tags": {
    },
  • "state": "active",
  • "error": "string",
  • "backend": "prometheus",
  • "config": {
    },
  • "config_data": {
    },
  • "format": "yaml",
  • "ts_created": "2019-08-24T14:15:22Z"
}

Delete an existing Sink configuration

path Parameters
id
required
string <uuid>

Unique Sink identifier.

header Parameters
Authorization
required
any

User's access token (bearer auth).

Responses

Response samples

Content type
application/json
"string"

List supported Sink backends and their configuration parameters

header Parameters
Authorization
required
any

User's access token (bearer auth).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List supported Sink Authentication types, based on OpenTelemetry Extensions

header Parameters
Authorization
required
any

User's access token (bearer auth).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a specific AuthenticationType based on the simple name from OpenTelemetry extension

path Parameters
id
required
string <string>

Unique Sink auth identifier.

header Parameters
Authorization
required
any

User's access token (bearer auth).

Responses

Response samples

Content type
application/json
{
  • "backend": "basicauth",
  • "description": "Basic Authentication over HTTPS",
  • "config": [
    ]
}

Get an existing Sink backend configuration

path Parameters
id
required
string <uuid>

Unique Backend identifier.

header Parameters
Authorization
required
any

User's access token (bearer auth).

Responses

Response samples

Content type
application/json
{
  • "backend": "prometheus",
  • "description": "Prometheus time series database sink",
  • "config": [
    ]
}

validate a sink configuration without saving it

header Parameters
Authorization
required
any

User's access token (bearer auth).

Request Body schema: application/json

JSON-formatted document describing the new Sink configuration

One of
name
required
string

A unique name label

description
string

User description of this Sink

tags
object

User defined key/values for organization and searching

backend
required
string

The sink backend to use. Must match a backend from /features/sinks. Cannot change once created.

config
required
object

Object representing backend specific configuration information

Responses

Request samples

Content type
application/json
Example
SinkCreateReqSchema
SinkCreateReqSchema
SinkCreateReqV2Schema
{
  • "name": "my-prom-sink",
  • "description": "An example prometheus sink",
  • "tags": {
    },
  • "backend": "prometheus",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "my-prom-sink",
  • "description": "An example prometheus sink",
  • "tags": {
    },
  • "state": "active",
  • "error": "string",
  • "backend": "prometheus",
  • "config": {
    },
  • "config_data": {
    },
  • "format": "yaml",
  • "ts_created": "2019-08-24T14:15:22Z"
}