Wherobots cloud-connections API
The cloud-connections API from Wherobots — 11 operation(s) for cloud-connections.
The cloud-connections API from Wherobots — 11 operation(s) for cloud-connections.
openapi: 3.1.0
info:
title: Wherobots Cloud apikey cloud-connections API
description: "Wherobots Cloud API OpenAPI specification.\n\n These are the API docs for the Wherobots API. You can use this to test out the API and see what it does.\n The underlying OPENAPI spec can be found at /openapi.json. This can be used to generate clients for the API.\n\n The Authorize button below will allow you to input an access token to authenticate to our API.\n Then all of the requests on the page should work.\n "
version: 0.0.1
servers:
- url: https://api.cloud.wherobots.com
description: Wherobots Cloud API
tags:
- name: cloud-connections
paths:
/cloud-connections:
get:
tags:
- cloud-connections
summary: List cloud connections
operationId: listCloudConnections
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CloudConnectionRead'
type: array
title: Response Listcloudconnections
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
security:
- bearerToken: []
- wherobotsApiKey: []
x-excluded: true
post:
tags:
- cloud-connections
summary: Create a cloud connection
operationId: createCloudConnection
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AwsCloudConnectionCreate'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CloudConnectionRead'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
security:
- bearerToken: []
- wherobotsApiKey: []
x-excluded: true
/cloud-connections/{connection_id}:
get:
tags:
- cloud-connections
summary: Get a cloud connection
operationId: getCloudConnection
security:
- bearerToken: []
- wherobotsApiKey: []
parameters:
- name: connection_id
in: path
required: true
schema:
type: string
title: Connection Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CloudConnectionRead'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
x-excluded: true
delete:
tags:
- cloud-connections
summary: Delete a cloud connection
operationId: deleteCloudConnection
security:
- bearerToken: []
- wherobotsApiKey: []
parameters:
- name: connection_id
in: path
required: true
schema:
type: string
title: Connection Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
x-excluded: true
/cloud-connections/{connection_id}/verify:
post:
tags:
- cloud-connections
summary: Verify a cloud connection (optionally with a proposed binding)
operationId: verifyCloudConnection
security:
- bearerToken: []
- wherobotsApiKey: []
parameters:
- name: connection_id
in: path
required: true
schema:
type: string
title: Connection Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CloudConnectionVerifyRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CloudConnectionVerifyResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
x-excluded: true
/cloud-connections/{connection_id}/create-link/connection:
get:
tags:
- cloud-connections
summary: Get a CloudFormation Quick-Create link for the connection stack
operationId: getCloudConnectionCreateLink
security:
- bearerToken: []
- wherobotsApiKey: []
parameters:
- name: connection_id
in: path
required: true
schema:
type: string
title: Connection Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/QuickCreateLinkResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
x-excluded: true
/cloud-connections/{connection_id}/create-link/storage:
get:
tags:
- cloud-connections
summary: Get a CloudFormation Quick-Create link for an S3 binding stack
operationId: getCloudConnectionStorageCreateLink
security:
- bearerToken: []
- wherobotsApiKey: []
parameters:
- name: connection_id
in: path
required: true
schema:
type: string
title: Connection Id
- name: bucket
in: query
required: true
schema:
type: string
minLength: 3
maxLength: 63
pattern: ^[a-z0-9.\-]+$
description: Name of the S3 bucket to grant access to (not an ARN or s3:// URL)
title: Bucket
description: Name of the S3 bucket to grant access to (not an ARN or s3:// URL)
- name: prefix
in: query
required: false
schema:
type: string
maxLength: 1024
pattern: ^[^&#\x00-\x1f\x7f]*$
description: Optional key prefix to scope access to; empty grants the whole bucket
default: ''
title: Prefix
description: Optional key prefix to scope access to; empty grants the whole bucket
- name: access
in: query
required: true
schema:
$ref: '#/components/schemas/CftAccessType'
description: Access level for the S3 binding stack
description: Access level for the S3 binding stack
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/QuickCreateLinkResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
x-excluded: true
/cloud-connections/{connection_id}/cft/connection:
get:
tags:
- cloud-connections
summary: Download the rendered CloudFormation template for the connection stack
operationId: downloadCloudConnectionTemplate
security:
- bearerToken: []
- wherobotsApiKey: []
parameters:
- name: connection_id
in: path
required: true
schema:
type: string
title: Connection Id
responses:
'200':
description: Successful Response
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
x-excluded: true
/cloud-connections/{connection_id}/cft/storage:
get:
tags:
- cloud-connections
summary: Download the rendered CloudFormation template for an S3 binding stack
operationId: downloadCloudConnectionStorageTemplate
security:
- bearerToken: []
- wherobotsApiKey: []
parameters:
- name: connection_id
in: path
required: true
schema:
type: string
title: Connection Id
- name: bucket
in: query
required: true
schema:
type: string
minLength: 3
maxLength: 63
pattern: ^[a-z0-9.\-]+$
description: Name of the S3 bucket to grant access to (not an ARN or s3:// URL)
title: Bucket
description: Name of the S3 bucket to grant access to (not an ARN or s3:// URL)
- name: prefix
in: query
required: false
schema:
type: string
maxLength: 1024
pattern: ^[^&#\x00-\x1f\x7f]*$
description: Optional key prefix to scope access to; empty grants the whole bucket
default: ''
title: Prefix
description: Optional key prefix to scope access to; empty grants the whole bucket
- name: access
in: query
required: true
schema:
$ref: '#/components/schemas/CftAccessType'
description: Access level for the S3 binding stack
description: Access level for the S3 binding stack
responses:
'200':
description: Successful Response
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
x-excluded: true
/cloud-connections/{connection_id}/create-link/glue:
get:
tags:
- cloud-connections
summary: Get a CloudFormation Quick-Create link for a Glue binding stack
operationId: getCloudConnectionGlueCreateLink
security:
- bearerToken: []
- wherobotsApiKey: []
parameters:
- name: connection_id
in: path
required: true
schema:
type: string
title: Connection Id
- name: name
in: query
required: true
schema:
type: string
minLength: 1
description: Name of the Glue binding/catalog; feeds the recommended stack name
title: Name
description: Name of the Glue binding/catalog; feeds the recommended stack name
- name: access
in: query
required: true
schema:
$ref: '#/components/schemas/CftAccessType'
description: Access level for the Glue binding stack
description: Access level for the Glue binding stack
- name: region
in: query
required: true
schema:
type: string
pattern: ^[a-z]{2}(-[a-z]+)+-\d$
description: AWS region where the Glue catalog lives
title: Region
description: AWS region where the Glue catalog lives
- name: awsAccountId
in: query
required: false
schema:
anyOf:
- type: string
pattern: ^\d{12}$
- type: 'null'
description: AWS account ID hosting the Glue catalog; defaults to the connection's account
title: Awsaccountid
description: AWS account ID hosting the Glue catalog; defaults to the connection's account
- name: bucket
in: query
required: false
schema:
type: string
pattern: ^$|^[a-z0-9.\-]{3,63}$
description: Optional S3 bucket for direct data access; empty grants no extra S3 access
default: ''
title: Bucket
description: Optional S3 bucket for direct data access; empty grants no extra S3 access
- name: prefix
in: query
required: false
schema:
type: string
maxLength: 1024
pattern: ^[^&#\x00-\x1f\x7f]*$
description: Optional key prefix to scope access to; empty grants the whole bucket
default: ''
title: Prefix
description: Optional key prefix to scope access to; empty grants the whole bucket
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/QuickCreateLinkResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
x-excluded: true
/cloud-connections/{connection_id}/cft/glue:
get:
tags:
- cloud-connections
summary: Download the rendered CloudFormation template for a Glue binding stack
operationId: downloadCloudConnectionGlueTemplate
security:
- bearerToken: []
- wherobotsApiKey: []
parameters:
- name: connection_id
in: path
required: true
schema:
type: string
title: Connection Id
- name: name
in: query
required: true
schema:
type: string
minLength: 1
description: Name of the Glue binding/catalog; feeds the recommended stack name
title: Name
description: Name of the Glue binding/catalog; feeds the recommended stack name
- name: access
in: query
required: true
schema:
$ref: '#/components/schemas/CftAccessType'
description: Access level for the Glue binding stack
description: Access level for the Glue binding stack
- name: region
in: query
required: true
schema:
type: string
pattern: ^[a-z]{2}(-[a-z]+)+-\d$
description: AWS region where the Glue catalog lives
title: Region
description: AWS region where the Glue catalog lives
- name: awsAccountId
in: query
required: false
schema:
anyOf:
- type: string
pattern: ^\d{12}$
- type: 'null'
description: AWS account ID hosting the Glue catalog; defaults to the connection's account
title: Awsaccountid
description: AWS account ID hosting the Glue catalog; defaults to the connection's account
- name: bucket
in: query
required: false
schema:
type: string
pattern: ^$|^[a-z0-9.\-]{3,63}$
description: Optional S3 bucket for direct data access; empty grants no extra S3 access
default: ''
title: Bucket
description: Optional S3 bucket for direct data access; empty grants no extra S3 access
- name: prefix
in: query
required: false
schema:
type: string
maxLength: 1024
pattern: ^[^&#\x00-\x1f\x7f]*$
description: Optional key prefix to scope access to; empty grants the whole bucket
default: ''
title: Prefix
description: Optional key prefix to scope access to; empty grants the whole bucket
responses:
'200':
description: Successful Response
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
x-excluded: true
/cloud-connections/{connection_id}/create-link/s3tables:
get:
tags:
- cloud-connections
summary: Get a CloudFormation Quick-Create link for an S3 Tables binding stack
operationId: getCloudConnectionS3TablesCreateLink
security:
- bearerToken: []
- wherobotsApiKey: []
parameters:
- name: connection_id
in: path
required: true
schema:
type: string
title: Connection Id
- name: tableBucketArn
in: query
required: true
schema:
type: string
pattern: ^arn:aws:s3tables:[a-z0-9\-]+:\d{12}:bucket/[a-z0-9][a-z0-9\-]{1,61}[a-z0-9]$
description: ARN of the S3 Table Bucket to grant access to
title: Tablebucketarn
description: ARN of the S3 Table Bucket to grant access to
- name: access
in: query
required: true
schema:
$ref: '#/components/schemas/CftAccessType'
description: Access level for the S3 Tables binding stack
description: Access level for the S3 Tables binding stack
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/QuickCreateLinkResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
x-excluded: true
/cloud-connections/{connection_id}/cft/s3tables:
get:
tags:
- cloud-connections
summary: Download the rendered CloudFormation template for an S3 Tables binding stack
operationId: downloadCloudConnectionS3TablesTemplate
security:
- bearerToken: []
- wherobotsApiKey: []
parameters:
- name: connection_id
in: path
required: true
schema:
type: string
title: Connection Id
- name: tableBucketArn
in: query
required: true
schema:
type: string
pattern: ^arn:aws:s3tables:[a-z0-9\-]+:\d{12}:bucket/[a-z0-9][a-z0-9\-]{1,61}[a-z0-9]$
description: ARN of the S3 Table Bucket to grant access to
title: Tablebucketarn
description: ARN of the S3 Table Bucket to grant access to
- name: access
in: query
required: true
schema:
$ref: '#/components/schemas/CftAccessType'
description: Access level for the S3 Tables binding stack
description: Access level for the S3 Tables binding stack
responses:
'200':
description: Successful Response
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBody'
x-excluded: true
components:
schemas:
ErrorInfo:
properties:
code:
$ref: '#/components/schemas/ErrorClass'
description: The error code
message:
type: string
title: Message
description: A human-readable message describin
# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wherobots/refs/heads/main/openapi/wherobots-cloud-connections-api-openapi.yml