stacks

Bring a stack up from a stack file (briq.yaml)

Changed on

Creates each service of the file the stack does not have, as POST /v1/briqs makes it and under the same checks: all of them or none. Leaves the services the stack has as they are; never changes or deletes one. Secrets the file names come in secrets. Answers once the new briqs are ready, for up to waitTimeoutMs, unless wait: false.

post/v1/stacks/up

Request

  • Base URL: https://api.briq.cloud
  • URL: https://api.briq.cloud/v1/stacks/up
  • Auth: HTTP bearer

Request body

filestring required

The stack file's content, YAML or JSON (briq.yaml)

stackstring

The stack to bring up instead of the file's stack: a branch's, a fork's

secretsobject

Values for the secrets the file names as { secret: NAME }: an API key briq cannot generate. Never in the file. A secret without a value here is generated

exposeboolean

Reach the stack from outside briq: database ports get TLS endpoints, and outputs use them and the URLs the file publishes. Waits for the briqs. The file's own expose still decides each URL's mode

waitboolean

Answer once the briqs are ready (healthcheck passed, or process started)

waitTimeoutMsinteger

How long to wait; a briq still creating then is on its way

Response

ok

stackstring required
createdstring[] required

The services this up made

existingstring[] required

The services the stack had: left as they are

warningsstring[]

An endpoint the file asks for that could not be opened yet; with expose, a briq not running whose outputs stay internal

outputsobject required

Each recipe's connection strings, the secrets briq generated, and <briq>:URL for each published service. A key two services both have is <briq>:<KEY>

costLinestring required

Changes