Skip to main content
GET
Get connector source

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The connector id, in the form key[@version][~owner] (e.g. hibob@1.2.0~stackone).

Query Parameters

format
enum<string> | null
default:yaml

How to return the definition: yaml for the connector YAML, json for the parsed connector serialized as JSON.

Available options:
yaml,
json,
unmapped_value,
null
version
string | null

The connector version to fetch. Overrides any version embedded in the id. Accepts latest, which is also the default.

owner
string | null

The owner of the connector version. Overrides any owner embedded in the id. Accepts the wildcards builtin (the global stackone owner) and custom (the project's own connectors). Required when both have a connector at the requested version.

Response

The connector source was retrieved.

key
string
required

The connector key.

Example:

"acmehr"

version
string
required

The version the request resolved to.

Example:

"1.2.0"

owner
string
required

The owner of the version; stackone for built-in connectors.

Example:

"stackone"

format
enum<string>
required

The format of content.

Available options:
yaml,
json
content
string
required

The connector definition: the YAML document, or the parsed connector as a JSON string, depending on format.