Skip to main content
API docs by Redocly

Booga Enterprise API (1.0.0)

Download OpenAPI specification:Download

Booga Enterprise Support: support@boogaenterprise.com URL: https://docs.boogaenterprise.com License: Proprietary

Comprehensive REST API for Booga Enterprise B2B Financial Analysis Platform

Authentication

User authentication and authorization endpoints

Tenants

Tenant management and configuration

API Management

API key and webhook management

Integrations

The default basic root view for DefaultRouter

The default basic root view for DefaultRouter

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

The default basic root view for DefaultRouter

The default basic root view for DefaultRouter

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

The default basic root view for DefaultRouter

The default basic root view for DefaultRouter

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

The default basic root view for DefaultRouter

The default basic root view for DefaultRouter

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

The default basic root view for DefaultRouter

The default basic root view for DefaultRouter

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

The default basic root view for DefaultRouter

The default basic root view for DefaultRouter

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

The default basic root view for DefaultRouter

The default basic root view for DefaultRouter

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

The default basic root view for DefaultRouter

The default basic root view for DefaultRouter

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

The default basic root view for DefaultRouter

The default basic root view for DefaultRouter

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

The default basic root view for DefaultRouter

The default basic root view for DefaultRouter

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

The default basic root view for DefaultRouter

The default basic root view for DefaultRouter

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

The default basic root view for DefaultRouter

The default basic root view for DefaultRouter

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

The default basic root view for DefaultRouter

The default basic root view for DefaultRouter

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

The default basic root view for DefaultRouter

The default basic root view for DefaultRouter

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

List and retrieve cloud file imports (read-only). Tenant-scoped. Supports status, retry.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

List available connectors (system, template, tenant) and user permissions.

List available connectors (system, template, tenant) and user permissions.

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

List available connectors (system, template, tenant) and user permissions.

List available connectors (system, template, tenant) and user permissions.

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

List available financial data providers from the connector registry.

List available financial data providers from the connector registry.

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

List available financial data providers from the connector registry.

List available financial data providers from the connector registry.

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Generate financial data compliance report (SOX, GDPR, audit, data access, security).

Generate financial data compliance report (SOX, GDPR, audit, data access, security).

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
format
string

json, csv, pdf (default json)

user_id
string

User ID

end_date
string

YYYY-MM-DD (default now)

stack_id
string

Stack ID

tenant_id
string

Tenant ID (admin only)

start_date
string

YYYY-MM-DD (default 30 days ago)

report_type
string

sox, gdpr, financial_audit, data_access, security (default financial_audit)

include_details
string

Include detailed events (true/false)

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Generate financial data compliance report (SOX, GDPR, audit, data access, security).

Generate financial data compliance report (SOX, GDPR, audit, data access, security).

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
format
string

json, csv, pdf (default json)

user_id
string

User ID

end_date
string

YYYY-MM-DD (default now)

stack_id
string

Stack ID

tenant_id
string

Tenant ID (admin only)

start_date
string

YYYY-MM-DD (default 30 days ago)

report_type
string

sox, gdpr, financial_audit, data_access, security (default financial_audit)

include_details
string

Include detailed events (true/false)

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Check if current user has authorized a user-level OAuth connection.

Check if current user has authorized a user-level OAuth connection.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
connection_id
required
string

IntegrationConnection UUID

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Check if current user has authorized a user-level OAuth connection.

Check if current user has authorized a user-level OAuth connection.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
connection_id
required
string

IntegrationConnection UUID

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Get connector library data from registry (replaces hardcoded frontend data) This endpoint combines registry data with system connector availability

Get connector library data from registry (replaces hardcoded frontend data) This endpoint combines registry data with system connector availability

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Get connector library data from registry (replaces hardcoded frontend data) This endpoint combines registry data with system connector availability

Get connector library data from registry (replaces hardcoded frontend data) This endpoint combines registry data with system connector availability

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Get dashboard statistics for integrations (connections, sync configs, executions).

Get dashboard statistics for integrations (connections, sync configs, executions).

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Get dashboard statistics for integrations (connections, sync configs, executions).

Get dashboard statistics for integrations (connections, sync configs, executions).

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Unified financial data with provider routing.

Unified financial data with provider routing.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
limit
string

Max results

query
string

For search type

period
string

1day, 5day, 1month, 3month, 6month, 1year, 5year

symbol
string

Required for price/historical/fundamentals/technicals

interval
string

daily, weekly, monthly, 1hour, 5min

stack_id
string

Stack ID if not set by middleware

data_type
required
string

price, historical, fundamentals, technicals, search, market

indicators
string

SMA, RSI, MACD, etc. for technicals

data_subtype
string

indices, sectors, gainers, losers for market

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Unified financial data with provider routing.

Unified financial data with provider routing.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
limit
string

Max results

query
string

For search type

period
string

1day, 5day, 1month, 3month, 6month, 1year, 5year

symbol
string

Required for price/historical/fundamentals/technicals

interval
string

daily, weekly, monthly, 1hour, 5min

stack_id
string

Stack ID if not set by middleware

data_type
required
string

price, historical, fundamentals, technicals, search, market

indicators
string

SMA, RSI, MACD, etc. for technicals

data_subtype
string

indices, sectors, gainers, losers for market

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Market-wide data (indices, sectors, gainers, losers).

Market-wide data (indices, sectors, gainers, losers).

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
stack_id
string

Stack ID if not from middleware

data_subtype
required
string

indices, sectors, gainers, losers

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Market-wide data (indices, sectors, gainers, losers).

Market-wide data (indices, sectors, gainers, losers).

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
stack_id
string

Stack ID if not from middleware

data_subtype
required
string

indices, sectors, gainers, losers

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Symbol search with provider routing

Symbol search with provider routing

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Symbol search with provider routing

Symbol search with provider routing

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Manage tenant/stack financial data provider configuration. GET: Current config. PUT: Update config. POST: Test provider connections.

Manage tenant/stack financial data provider configuration. GET: Current config. PUT: Update config. POST: Test provider connections.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
body
string

Provider config or test params per implementation

stack_id
string

Stack ID for GET/PUT

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Manage tenant/stack financial data provider configuration. GET: Current config. PUT: Update config. POST: Test provider connections.

Manage tenant/stack financial data provider configuration. GET: Current config. PUT: Update config. POST: Test provider connections.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
body
string

Provider config or test params per implementation

stack_id
string

Stack ID for GET/PUT

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Manage tenant/stack financial data provider configuration. GET: Current config. PUT: Update config. POST: Test provider connections.

Manage tenant/stack financial data provider configuration. GET: Current config. PUT: Update config. POST: Test provider connections.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
body
string

Provider config or test params per implementation

stack_id
string

Stack ID for GET/PUT

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Manage tenant/stack financial data provider configuration. GET: Current config. PUT: Update config. POST: Test provider connections.

Manage tenant/stack financial data provider configuration. GET: Current config. PUT: Update config. POST: Test provider connections.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
body
string

Provider config or test params per implementation

stack_id
string

Stack ID for GET/PUT

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Health check for integrations plugin.

Health check for integrations plugin.

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Health check for integrations plugin.

Health check for integrations plugin.

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Initiate OAuth flow for a cloud storage/communication connector.

Initiate OAuth flow for a cloud storage/communication connector.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
redirect_uri
required
string

OAuth redirect URI

connection_id
required
string

IntegrationConnection UUID

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Initiate OAuth flow for a cloud storage/communication connector.

Initiate OAuth flow for a cloud storage/communication connector.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
redirect_uri
required
string

OAuth redirect URI

connection_id
required
string

IntegrationConnection UUID

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Handle OAuth callback from any cloud storage provider

Handle OAuth callback from any cloud storage provider

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Handle OAuth callback from any cloud storage provider

Handle OAuth callback from any cloud storage provider

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Initiate OAuth flow for a cloud storage/communication connector.

Initiate OAuth flow for a cloud storage/communication connector.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
redirect_uri
required
string

OAuth redirect URI

connection_id
required
string

IntegrationConnection UUID

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Initiate OAuth flow for a cloud storage/communication connector.

Initiate OAuth flow for a cloud storage/communication connector.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
redirect_uri
required
string

OAuth redirect URI

connection_id
required
string

IntegrationConnection UUID

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Handle OAuth callback from any cloud storage provider

Handle OAuth callback from any cloud storage provider

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Handle OAuth callback from any cloud storage provider

Handle OAuth callback from any cloud storage provider

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Initiate OAuth flow for a cloud storage/communication connector.

Initiate OAuth flow for a cloud storage/communication connector.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
redirect_uri
required
string

OAuth redirect URI

connection_id
required
string

IntegrationConnection UUID

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Initiate OAuth flow for a cloud storage/communication connector.

Initiate OAuth flow for a cloud storage/communication connector.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
redirect_uri
required
string

OAuth redirect URI

connection_id
required
string

IntegrationConnection UUID

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Handle OAuth callback from any cloud storage provider

Handle OAuth callback from any cloud storage provider

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Handle OAuth callback from any cloud storage provider

Handle OAuth callback from any cloud storage provider

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Initiate OAuth flow for a cloud storage/communication connector.

Initiate OAuth flow for a cloud storage/communication connector.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
redirect_uri
required
string

OAuth redirect URI

connection_id
required
string

IntegrationConnection UUID

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Initiate OAuth flow for a cloud storage/communication connector.

Initiate OAuth flow for a cloud storage/communication connector.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
redirect_uri
required
string

OAuth redirect URI

connection_id
required
string

IntegrationConnection UUID

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Handle OAuth callback from any cloud storage provider

Handle OAuth callback from any cloud storage provider

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Handle OAuth callback from any cloud storage provider

Handle OAuth callback from any cloud storage provider

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Initiate OAuth flow for a cloud storage/communication connector.

Initiate OAuth flow for a cloud storage/communication connector.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
redirect_uri
required
string

OAuth redirect URI

connection_id
required
string

IntegrationConnection UUID

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Initiate OAuth flow for a cloud storage/communication connector.

Initiate OAuth flow for a cloud storage/communication connector.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
redirect_uri
required
string

OAuth redirect URI

connection_id
required
string

IntegrationConnection UUID

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Handle OAuth callback from any cloud storage provider

Handle OAuth callback from any cloud storage provider

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Handle OAuth callback from any cloud storage provider

Handle OAuth callback from any cloud storage provider

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Initiate OAuth flow for a cloud storage/communication connector.

Initiate OAuth flow for a cloud storage/communication connector.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
redirect_uri
required
string

OAuth redirect URI

connection_id
required
string

IntegrationConnection UUID

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Initiate OAuth flow for a cloud storage/communication connector.

Initiate OAuth flow for a cloud storage/communication connector.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
redirect_uri
required
string

OAuth redirect URI

connection_id
required
string

IntegrationConnection UUID

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "string",
  • "meta": {
    }
}

Handle OAuth callback from any cloud storage provider

Handle OAuth callback from any cloud storage provider

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Handle OAuth callback from any cloud storage provider

Handle OAuth callback from any cloud storage provider

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Manage integration connections (OAuth, REST, webhook, cloud storage, etc.). CRUD for connections; tenant and stack scoped. Supports test_connection, reauthorize, playground, test_config, schema, browse, search, file-metadata, import, webhook/receive.

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "user": "string",
  • "stack": "string",
  • "config": { },
  • "status": "a",
  • "tenant": "string",
  • "last_sync": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "stack_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "credentials": { },
  • "description": "string",
  • "error_count": 0,
  • "last_tested": "2019-08-24T14:15:22Z",
  • "tenant_name": "string",
  • "connector_type": "s",
  • "status_display": "string",
  • "created_by_name": "string",
  • "connection_health": "string",
  • "last_sync_relative": "string",
  • "connector_type_display": "string"
}

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{ }

ViewSet for ConnectorRegistry management (SuperUser only)

ViewSet for ConnectorRegistry management (SuperUser only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncExecution monitoring (read-only)

ViewSet for SyncExecution monitoring (read-only)

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "p",
  • "started_at": "2019-08-24T14:15:22Z",
  • "sync_config": "string",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_details": { },
  • "error_message": "string",
  • "execution_log": "string",
  • "execution_type": "m",
  • "records_failed": 0,
  • "status_display": "string",
  • "records_created": 0,
  • "records_updated": 0,
  • "duration_seconds": 0,
  • "sync_config_name": "string",
  • "records_processed": 0,
  • "execution_type_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for SyncConfiguration management

ViewSet for SyncConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "sync_type": "f",
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "data_source": "string",
  • "description": "string",
  • "success_rate": "string",
  • "schedule_cron": "string",
  • "field_mappings": { },
  • "next_sync_time": "string",
  • "sync_direction": "i",
  • "connection_name": "string",
  • "execution_count": "string",
  • "transformations": { },
  • "schedule_enabled": true,
  • "schedule_timezone": "string",
  • "sync_type_display": "string",
  • "conflict_resolution": "s",
  • "last_execution_status": "string",
  • "scheduler_schedule_id": "64688909-43ee-4e2f-b6c7-adc05184606c",
  • "sync_direction_display": "string",
  • "conflict_resolution_display": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

Generic webhook handler view

Generic webhook handler view

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Generic webhook handler view

Generic webhook handler view

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Generic webhook handler view

Generic webhook handler view

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Generic webhook handler view

Generic webhook handler view

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Generic webhook handler view

Generic webhook handler view

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Generic webhook handler view

Generic webhook handler view

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Generic webhook handler view

Generic webhook handler view

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}

ViewSet for WebhookConfiguration management

ViewSet for WebhookConfiguration management

Required capability: integrations_access

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Unique identifier for the resource

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 100 ]
Default: 20

Number of results per page

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "is_active": true,
  • "connection": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "secret_key": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "event_types": { },
  • "webhook_url": "string",
  • "endpoint_path": "string",
  • "connection_name": "string",
  • "signature_header": "string",
  • "target_sync_configs": "string",
  • "transformation_rules": { },
  • "target_sync_configs_count": "string"
}