Skip to Content
veriom

Create cloud connection

Start connecting a cloud account; answers the links that create its read-only identity. The links carry a single-use callback token valid for 24 hours. Once the identity reports back, Veriom proposes the collection workflow as a draft pull request.

POST
/v1/workspaces/{workspace_id}/cloud-connections

Start connecting a cloud account; answers the links that create its read-only identity.

The links carry a single-use callback token valid for 24 hours. Once the identity reports back, Veriom proposes the collection workflow as a draft pull request.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Request Body

application/json
  1. body
location?|

Azure: the region the deployment and identity live in. Defaults to eastus.

project_id?|

GCP: the project. Defaults to the project Cloud Shell is opened in.

provider*Provider
Value in"aws""azure""gcp"
region?|

AWS: the region the workflow collects. Defaults to us-east-1.

repository_id*Repository Id

The connected GitHub repository whose CI collects this cloud account. Only runs of its default branch can use the identity the template creates.

Formatuuid

Response Body

Successful Response

application/json
  1. response
account_ref?|

AWS account id, Azure subscription id or GCP project id, once ready.

callback_expires_at*|null
completed_at*|null
created_at*Created At
Formatdate-time
id*Id
Formatuuid
last_snapshot_at*|null
parameters*
provider*Provider
Value in"aws""azure""gcp"
repository_id*Repository Id
Formatuuid
setup*

How to create the read-only identity. Holds the single-use callback token in its links.

setup_pull_request_number*integer|null
setup_pull_request_url*string|null
state*State
Value in"pending""ready""revoked"
subject*Subject

The GitHub OIDC subject the cloud identity trusts.

workspace_id*Workspace Id
Formatuuid
Example Request
curl -X POST 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/cloud-connections' \  -H 'Content-Type: application/json' \  -d '{  "provider": "aws",  "repository_id": "b349ae61-b973-4c6c-a5e0-89183ba99ff3"}'
Example Response
{  "account_ref": "string",  "callback_expires_at": "2019-08-24T14:15:22Z",  "completed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "last_snapshot_at": "2019-08-24T14:15:22Z",  "parameters": {    "property1": "string",    "property2": "string"  },  "provider": "aws",  "repository_id": "b349ae61-b973-4c6c-a5e0-89183ba99ff3",  "setup": {    "callback_expires_at": "2019-08-24T14:15:22Z",    "console_url": "string",    "deploy_url": "string",    "quick_create_url": "string",    "quick_create_url_existing_provider": "string",    "setup_command": "string",    "template_url": "string",    "template_version": "string"  },  "setup_pull_request_number": 0,  "setup_pull_request_url": "string",  "state": "pending",  "subject": "string",  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"}