Get all connector groups

GET 
/sse/connector/v2.0/api/connector-groups

Get a list of all available connector groups.

Request

Query Parameters

offset number

0-based offset into the list, starting entity for pagination

limit number

How many records to get

Responses

200

OK

application/json

Schema

Schema

limit numberrequired

The offset that points to the beginning of the next page. May be same as total.

offset numberrequired

Starting entity for Pagination (0-based. i.e. first entity starts at 0)

total numberrequired

Total number of entries available

data object[]required
Array [
description string
is_autoscale booleanrequired
name stringrequired
oid stringrequired
Connector Group ID
created_time string
updated_time string
error object
state number
state_bits number
token_active string
token_secret string
applications object
App oid to app name mappings
connectors object
Connector oid to connector name mappings
]

Example (from schema)

{
  "limit": 0,
  "offset": 0,
  "total": 0,
  "data": [
    {
      "description": "string",
      "is_autoscale": true,
      "name": "string",
      "oid": "string",
      "created_time": "string",
      "updated_time": "string",
      "error": {},
      "state": 0,
      "state_bits": 0,
      "token_active": "string",
      "token_secret": "string",
      "applications": {},
      "connectors": {}
    }
  ]
}

400

Bad Request because an oid required by specific endpoint is missing from request

application/json

Schema

Schema

error object
oneOf
google.rpc.Code.InvalidArgument
code number
Possible values: [3]
details object[]
Array [
anyOf
Retry Info
@type string
Possible values: [type.googleapis.com/google.rpc.RetryInfo]
retry_delay object
nanos number
seconds number
Debug Info
@type string
Possible values: [type.googleapis.com/google.rpc.DebugInfo]
detail string
stack_entries string[]
Quota Failure
@type string
Possible values: [type.googleapis.com/google.rpc.QuotaFailure]
violations object[]
Array [
description string
subject string
]
Error Info
@type string
Possible values: [type.googleapis.com/google.rpc.ErrorInfo]
domain string
metadata object
property name* string
reason string
Precondition Failure
@type string
Possible values: [type.googleapis.com/google.rpc.PreconditionFailure]
violations object[]
Array [
description string
subject string
type string
]
Bad Request
@type string
Possible values: [type.googleapis.com/google.rpc.BadRequest]
field_violations object[]
Array [
description string
field string
]
Request Info
@type string
Possible values: [type.googleapis.com/google.rpc.RequestInfo]
request_id string
serving_data string
Resource Info
@type string
Possible values: [type.googleapis.com/google.rpc.ResourceInfo]
description string
owner string
resource_name string
resource_type string
Help
@type string
Possible values: [type.googleapis.com/google.rpc.Help]
links object[]
Array [
description string
url string
]
Localized Message
@type string
Possible values: [type.googleapis.com/google.rpc.LocalizedMessage]
locale string
message string
Cause Info
@type stringrequired
Possible values: [google-cloud-api/CauseInfo]
causes object[]required
Array [
causes
message stringrequired
module string
]
]
message string
google.rpc.Code.FailedPrecondition
code number
Possible values: [9]
details object[]
Array [
anyOf
Retry Info
@type string
Possible values: [type.googleapis.com/google.rpc.RetryInfo]
retry_delay object
nanos number
seconds number
Debug Info
@type string
Possible values: [type.googleapis.com/google.rpc.DebugInfo]
detail string
stack_entries string[]
Quota Failure
@type string
Possible values: [type.googleapis.com/google.rpc.QuotaFailure]
violations object[]
Array [
description string
subject string
]
Error Info
@type string
Possible values: [type.googleapis.com/google.rpc.ErrorInfo]
domain string
metadata object
property name* string
reason string
Precondition Failure
@type string
Possible values: [type.googleapis.com/google.rpc.PreconditionFailure]
violations object[]
Array [
description string
subject string
type string
]
Bad Request
@type string
Possible values: [type.googleapis.com/google.rpc.BadRequest]
field_violations object[]
Array [
description string
field string
]
Request Info
@type string
Possible values: [type.googleapis.com/google.rpc.RequestInfo]
request_id string
serving_data string
Resource Info
@type string
Possible values: [type.googleapis.com/google.rpc.ResourceInfo]
description string
owner string
resource_name string
resource_type string
Help
@type string
Possible values: [type.googleapis.com/google.rpc.Help]
links object[]
Array [
description string
url string
]
Localized Message
@type string
Possible values: [type.googleapis.com/google.rpc.LocalizedMessage]
locale string
message string
Cause Info
@type stringrequired
Possible values: [google-cloud-api/CauseInfo]
causes object[]required
Array [
causes
message stringrequired
module string
]
]
message string

Example (from schema)

{
  "error": {}
}

401

Unauthorized

application/json

Schema

Schema

error object
code number
Possible values: [16]
details object[]
Array [
anyOf
Retry Info
@type string
Possible values: [type.googleapis.com/google.rpc.RetryInfo]
retry_delay object
nanos number
seconds number
Debug Info
@type string
Possible values: [type.googleapis.com/google.rpc.DebugInfo]
detail string
stack_entries string[]
Quota Failure
@type string
Possible values: [type.googleapis.com/google.rpc.QuotaFailure]
violations object[]
Array [
description string
subject string
]
Error Info
@type string
Possible values: [type.googleapis.com/google.rpc.ErrorInfo]
domain string
metadata object
property name* string
reason string
Precondition Failure
@type string
Possible values: [type.googleapis.com/google.rpc.PreconditionFailure]
violations object[]
Array [
description string
subject string
type string
]
Bad Request
@type string
Possible values: [type.googleapis.com/google.rpc.BadRequest]
field_violations object[]
Array [
description string
field string
]
Request Info
@type string
Possible values: [type.googleapis.com/google.rpc.RequestInfo]
request_id string
serving_data string
Resource Info
@type string
Possible values: [type.googleapis.com/google.rpc.ResourceInfo]
description string
owner string
resource_name string
resource_type string
Help
@type string
Possible values: [type.googleapis.com/google.rpc.Help]
links object[]
Array [
description string
url string
]
Localized Message
@type string
Possible values: [type.googleapis.com/google.rpc.LocalizedMessage]
locale string
message string
Cause Info
@type stringrequired
Possible values: [google-cloud-api/CauseInfo]
causes object[]required
Array [
causes
message stringrequired
module string
]
]
message string

Example (from schema)

{
  "error": {
    "code": 16,
    "details": [
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {}
    ],
    "message": "string"
  }
}

not_authenticated

Not Authenticated

{
  "error": {
    "code": 16,
    "message": "Not Authenticated"
  }
}

token_expired

Token Expired

{
  "error": {
    "code": 16,
    "message": "Token Expired"
  }
}

Loading...