Skip to content
Authrim

Preview destination provider payload

POST
/api/admin/destinations/provider-preview
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/destinations/provider-preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "provider": "http", "provider_config": { "url": "https://logs.example.com/ingest", "timeoutMs": 5000 }, "capabilities": [ "log_sink_write" ] }'

Validates provider_config for a destination provider, redacts secret-looking fields, and reports default capabilities and runtime support.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
provider
required
string
Allowed values: r2 aws_s3 http logpush analytics_engine firehose external custom
provider_config
object
key
additional properties
capabilities
Array<string>
key
additional properties
Example 
{
  "provider": "http",
  "provider_config": {
    "url": "https://logs.example.com/ingest",
    "timeoutMs": 5000
  },
  "capabilities": [
    "log_sink_write"
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Provider payload preview and validation result.

Media type application/json
object
item
required
object
key
additional properties
key
additional properties
Example 
{
  "item": {
    "provider": "http",
    "destination_kind": "http_sink",
    "provider_config": {
      "url": "https://logs.example.com/ingest",
      "timeoutMs": 5000
    },
    "schema": {
      "required_fields": [
        "url"
      ],
      "optional_fields": [
        "authProfile",
        "headerProfile",
        "timeoutMs"
      ],
      "default_capabilities": [
        "log_sink_write"
      ]
    },
    "runtime": {
      "supported": true,
      "status": "supported",
      "unsupported_reason": null
    },
    "capabilities": [
      "log_sink_write"
    ],
    "validation": {
      "valid": true,
      "errors": []
    },
    "security": {
      "inline_secret_detected": false,
      "inline_secret_path": null,
      "credential_ref_required": true
    }
  }
}

default

Section titled “default ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}