Atlas
Admin — Sandbox

Connect a sandbox provider

Validates credentials against the provider API and saves them for this org.

POST
/api/v1/admin/sandbox/connect/{provider}

Path Parameters

provider*string
Length1 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3001/api/v1/admin/sandbox/connect/vercel" \  -H "Content-Type: application/json" \  -d '{    "credentials": {      "property1": null,      "property2": null    }  }'
{
  "connected": true,
  "displayName": "string",
  "validatedAt": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}