Create source

Create source

curl --request POST \
  --url https://api.portable.io/v2/sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceSpec": "google_calendar"
}
'

{
  "data": {
    "$ref": "#/components/examples/sourceWithNoProperties/value"
  }
}

POST

sources

Create source

curl --request POST \
  --url https://api.portable.io/v2/sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceSpec": "google_calendar"
}
'

{
  "data": {
    "$ref": "#/components/examples/sourceWithNoProperties/value"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Source to create

sourceSpec

string

required

The name of the source spec to create a source for

displayName

string

A human-readable name for the source

properties

object

Show child attributes

properties.{key}

string

Response

Created

data

object

required

Show child attributes

data.id

integer<int>

required

data.sourceSpec

object

required

Show child attributes

data.sourceSpec.name

string

data.sourceSpec.displayName

string

data.sourceSpec.website

string<uri>

data.sourceSpec.tagLine

string

data.sourceSpec.lifecycle

enum<string>

Available options:

ALPHA,

BETA,

STABLE,

DEPRECATED

data.sourceSpec.authenticationStrategy

enum<string>

Available options:

NONE,

BASIC,

TOKEN,

AUTH_CODE,

CLIENT_CREDENTIALS,

FETCH_CREDENTIALS,

OIDC

data.sourceSpec.instructions

string

data.sourceSpec.propertyDefinitions

object[]

Show child attributes

data.sourceSpec.propertyDefinitions.name

string

required

A machine-readable name for the property

data.sourceSpec.propertyDefinitions.type

enum<string>

required

The type of the property

Available options:

STRING,

PASSWORD,

TEXT,

NUMBER,

BOOLEAN,

DATE,

DATETIME,

TIME

data.sourceSpec.propertyDefinitions.required

boolean

required

Whether the property's value is required

data.sourceSpec.propertyDefinitions.displayName

string

A human-readable name for the property

data.sourceSpec.propertyDefinitions.description

string

A human-readable description of the property

Example:

{
  "$ref": "#/components/examples/sourceSpecGcal/value"
}

data.displayName

string

A human-readable name for the source

data.properties

object

The properties of the source. This is a map of property names to their values. The names are defined in the propertyDefinitions field of the source spec.

Show child attributes

data.properties.{key}

string

data.createdAt

string<date-time>

The timestamp marking when the source was created

data.updatedAt

string<date-time>

The timestamp marking when the source was last updated

List sources Get source

⌘I

API Documentation

Source Specs

Sources

Destination Specs

Destinations

Flows

Authorizations

Body

Response