Settings API

Connections

The company’s accounts elsewhere, whichever product uses them: GitHub — Cloud builds from it and runs its runners — and AWS, whose SES the mail may leave through and whose bucket Drive may keep its files in.

URL base https://cloud.yet.com.br/v1 · https://acme.yet.com.br/api/settings

Settings respondem no endereço da sua empresa — acme aqui — e aceitam a key de quem administra o Settings.

As descrições dos endpoints estão em inglês.

List connections

GET/v1/connections

Each, and whether it is connected.

Requisição

curl https://cloud.yet.com.br/v1/connections \
  -H "Authorization: Bearer $YET_API_KEY"

Connect with a token

PUT/v1/connections/{kind}

In place of Yet’s GitHub App installation.

Quem: Cloud admin

Corpo

tokenstringobrigatório: The account’s token.

Requisição

curl -X PUT https://cloud.yet.com.br/v1/connections/{kind} \
  -H "Authorization: Bearer $YET_API_KEY"

Disconnect

DELETE/v1/connections/{kind}

Builds and runners from it stop.

Quem: Cloud admin

Requisição

curl -X DELETE https://cloud.yet.com.br/v1/connections/{kind} \
  -H "Authorization: Bearer $YET_API_KEY"

Resposta · 204 Sem conteúdo

GitHub App install address

GET/v1/connections/github/install

Where a person installs Yet’s GitHub App, to come back to return.

Requisição

curl https://cloud.yet.com.br/v1/connections/github/install \
  -H "Authorization: Bearer $YET_API_KEY"

List repositories

GET/v1/connections/github/repositories

The company’s repositories Cloud can build.

Requisição

curl https://cloud.yet.com.br/v1/connections/github/repositories \
  -H "Authorization: Bearer $YET_API_KEY"

Get the AWS account

GET/api/settings/aws

Its region and access key id — never the secret — or null.

Quem: Runs the company’s Settings

Requisição

curl https://acme.yet.com.br/api/settings/aws \
  -H "Authorization: Bearer $YET_API_KEY"

Resposta · 200

{
  "aws": {
    "region": "us-east-1",
    "access_key_id": "AKIA…"
  }
}

Connect the AWS account

PUT/api/settings/aws

Checked with AWS, sealed, and the company’s domains registered in its SES.

Quem: Runs the company’s Settings

Corpo

regionstringobrigatório: Its region.
access_key_idstringobrigatório: The key’s id.
secret_access_keystringobrigatório: The key’s secret.

Requisição

curl -X PUT https://acme.yet.com.br/api/settings/aws \
  -H "Authorization: Bearer $YET_API_KEY"

Disconnect it

DELETE/api/settings/aws

The key goes; mail through it stops.

Quem: Runs the company’s Settings

Requisição

curl -X DELETE https://acme.yet.com.br/api/settings/aws \
  -H "Authorization: Bearer $YET_API_KEY"