Skip to content
PAASBOX PAASBOX PAASBOX

Create or update a connection

PUT
/api/v1/teams/{team_slug}/connections/{ref}/
 
curl --request PUT \
  --url https://example.com/api/v1/teams/example/connections/example/ \
  --header 'Content-Type: application/json' \
  --cookie sessionid=<sessionid> \
  --data '{ "spec": { "name": "example", "provider": "hcloud", "token": "example", "providerConfig": { "additionalProperty": "example" } } }'

/api/v1/teams/{team}/connections — a connected Hetzner Cloud project (docs/58 §3.3). The token is write-only (P7); a Connection is referenced elsewhere by its ref.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
ref
required
string
team_slug
required
string

Request Body required

Section titled “Request Body required ”
object
spec
required

A Connection spec (docs/58 §3.3). token is write-only — it enters once and is never echoed (P7); a Connection is referenced elsewhere by its server-set ref.

object
name
required
string
<= 100 characters
provider
string
Allowed values: hcloud onprem
token
string
providerConfig
object
key
additional properties

Responses

Section titled “ Responses ”

200

Section titled “200 ”
Media type application/json

A Connection resource (docs/58 §3.3).

object
apiVersion
required
string
kind
required
string
metadata
required
object
key
additional properties
spec
required
object
key
additional properties
status
required
object
key
additional properties
Example generated
{
  "apiVersion": "example",
  "kind": "example",
  "metadata": {
    "additionalProperty": "example"
  },
  "spec": {
    "additionalProperty": "example"
  },
  "status": {
    "additionalProperty": "example"
  }
}

201

Section titled “201 ”
Media type application/json

A Connection resource (docs/58 §3.3).

object
apiVersion
required
string
kind
required
string
metadata
required
object
key
additional properties
spec
required
object
key
additional properties
status
required
object
key
additional properties
Example generated
{
  "apiVersion": "example",
  "kind": "example",
  "metadata": {
    "additionalProperty": "example"
  },
  "spec": {
    "additionalProperty": "example"
  },
  "status": {
    "additionalProperty": "example"
  }
}

422

Section titled “422 ”

RFC 7807 problem document

Media type application/json

RFC 7807 application/problem+json — every non-2xx response (docs/58 §5.10).

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
code
required

Stable machine code clients switch on

string
instance
required
string
nullable
operationId
required
string
nullable
Example generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "instance": "example",
  "operationId": "example"
}