Outpost API

​Schemas

Endpoint:http://localhost:3333/api/v1

Operations for retrieving destination type schemas.

​List Destination Type Schemas (for Tenant)

GET
http://localhost:3333/api/v1
/{tenant_id}/destination-types

Returns a list of JSON-based input schemas for each available destination type. Requires Admin API Key or Tenant JWT.

​List Destination Type Schemas (for Tenant) › path Parameters

  • tenant_idstring · required

    The ID of the tenant. Required when using AdminApiKey authentication.

​List Destination Type Schemas (for Tenant) › Responses

    object[]
    • typestring
    • labelstring
    • descriptionstring
    • iconstring

      SVG icon string.

    • instructionsstring

      Markdown instructions.

    • remote_setup_urlstring · url

      Some destinations may have Oauth flow or other managed-setup flow that can be triggered with a link. If a remote_setup_url is set then the user should be prompted to follow the link to configure the destination. See the dashboard design guide for recommended UI patterns and wireframes for implementation in your own app.

    • config_fieldsobject[]

      Config fields are non-secret values that can be stored and displayed to the user in plain text.

    • credential_fieldsobject[]

      Credential fields are secret values that will be AES encrypted and obfuscated to the user. Some credentials may not be obfuscated; the destination type dictates the obfuscation logic.

​Get Destination Type Schema (for Tenant)

GET
http://localhost:3333/api/v1
/{tenant_id}/destination-types/{type}

Returns the input schema for a specific destination type. Requires Admin API Key or Tenant JWT.

​Get Destination Type Schema (for Tenant) › path Parameters

  • tenant_idstring · required

    The ID of the tenant. Required when using AdminApiKey authentication.

  • typestring · enum · required

    The type of the destination.

    Enum values:
    webhook
    aws_sqs
    rabbitmq

​Get Destination Type Schema (for Tenant) › Responses

    • typestring
    • labelstring
    • descriptionstring
    • iconstring

      SVG icon string.

    • instructionsstring

      Markdown instructions.

    • remote_setup_urlstring · url

      Some destinations may have Oauth flow or other managed-setup flow that can be triggered with a link. If a remote_setup_url is set then the user should be prompted to follow the link to configure the destination. See the dashboard design guide for recommended UI patterns and wireframes for implementation in your own app.

    • config_fieldsobject[]

      Config fields are non-secret values that can be stored and displayed to the user in plain text.

    • credential_fieldsobject[]

      Credential fields are secret values that will be AES encrypted and obfuscated to the user. Some credentials may not be obfuscated; the destination type dictates the obfuscation logic.

​List Destination Type Schemas (JWT Auth)

GET
http://localhost:3333/api/v1
/destination-types

Returns a list of JSON-based input schemas for each available destination type (infers tenant from JWT).

​List Destination Type Schemas (JWT Auth) › Responses

    object[]
    • typestring
    • labelstring
    • descriptionstring
    • iconstring

      SVG icon string.

    • instructionsstring

      Markdown instructions.

    • remote_setup_urlstring · url

      Some destinations may have Oauth flow or other managed-setup flow that can be triggered with a link. If a remote_setup_url is set then the user should be prompted to follow the link to configure the destination. See the dashboard design guide for recommended UI patterns and wireframes for implementation in your own app.

    • config_fieldsobject[]

      Config fields are non-secret values that can be stored and displayed to the user in plain text.

    • credential_fieldsobject[]

      Credential fields are secret values that will be AES encrypted and obfuscated to the user. Some credentials may not be obfuscated; the destination type dictates the obfuscation logic.

​Get Destination Type Schema (JWT Auth)

GET
http://localhost:3333/api/v1
/destination-types/{type}

Returns the input schema for a specific destination type (infers tenant from JWT).

​Get Destination Type Schema (JWT Auth) › path Parameters

  • typestring · enum · required

    The type of the destination.

    Enum values:
    webhook
    aws_sqs
    rabbitmq

​Get Destination Type Schema (JWT Auth) › Responses

    • typestring
    • labelstring
    • descriptionstring
    • iconstring

      SVG icon string.

    • instructionsstring

      Markdown instructions.

    • remote_setup_urlstring · url

      Some destinations may have Oauth flow or other managed-setup flow that can be triggered with a link. If a remote_setup_url is set then the user should be prompted to follow the link to configure the destination. See the dashboard design guide for recommended UI patterns and wireframes for implementation in your own app.

    • config_fieldsobject[]

      Config fields are non-secret values that can be stored and displayed to the user in plain text.

    • credential_fieldsobject[]

      Credential fields are secret values that will be AES encrypted and obfuscated to the user. Some credentials may not be obfuscated; the destination type dictates the obfuscation logic.

PublishTopics