DEdecodable
Declarative Operations

Apply (create/update) a series of resources

See: apply command docs for usage details.

Requires appropriate permissions matching resources involved.

post/apply

Request

  • Base URL
    https://replace-with-account.api.decodable.co/v1alpha2
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization codehttps://auth.decodable.co/authorize?audience=https://api.decodable.co/
      Token URLhttps://auth.decodable.co/oauth/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body application/x-yaml

kind'secret' | 'stream' | 'connection' | 'pipeline' required

The resource kind.

spec_version'v1' required

The spec version for this resource definition.

Example request

{
  "spec": {
    "stream_mappings": [
      {
        "stream_id": "abcd1234"
      }
    ],
    "stream_id": "abcd1234",
    "autoscale_configuration": {
      "pause_conditions": {
        "max_record_read_rate": {
          "record_count": "100",
          "duration_seconds": "300"
        },
        "max_job_runtime": {
          "duration_seconds": "3600"
        }
      },
      "resume_conditions": {
        "schedule": {
          "cron_expression": "0 8 * * *"
        }
      }
    }
  }
}

Response

Success: Zero or more YAML docs, each with this schema.

Note that the response will be application/x-yaml by default (with one YAML doc per resource definition), but application/json may be selected via the Accept: request header.

kind'secret' | 'stream' | 'connection' | 'pipeline' required

The resource kind.

namestring required

The resource name.

idstring required

The resource ID.

result'created' | 'updated' | 'unchanged' | 'deleted' required
dry_runboolean

When true, this was a dry run, and no actual changes were made.

Changes

No recorded changes to this operation across all 1 revision of this API.