Akter

Builds

Builds are uploaded app bundles with their manifest; a Ready build can be deployed.

List⁠

GEThttps://api.akter.dev/v1/organizations/{organization}/apps/{app}/builds
builds.listBearer token

List an app's builds, a page at a time.

Path parameters

  • appstringrequired

    An app's name, unique within its organization. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • organizationstringrequired

    An organization's name, unique across Akter Cloud. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

Query parameters

  • cursorstring

    The nextCursor of the previous page.

  • limitinteger

    At most this many items, 1 to 100. Defaults to 50.

Response 200BuildPage

  • itemsBuild[]required
  • items[].appstringrequired

    An app's name, unique within its organization. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • items[].createdAtstringrequired
  • items[].digeststringrequired

    A SHA-256 digest as 64 lowercase hex characters.

  • items[].idstringrequired

    An opaque id that starts with bld_.

  • items[].manifestBuildManifestrequired

    build.json: the actor types, contract hashes and migrations of a build.

  • items[].manifest.actorsBuildActor[]required
  • items[].sizeintegerrequired

    The build's size in bytes.

  • items[].status"Uploading" | "Building" | "Ready" | "Failed"required
  • nextCursorstring

    Pass as cursor for the next page.

Errors

  • 401UnauthorizedError
  • 403ForbiddenError
  • 404NotFoundError | FeatureNotEnabledError
  • 503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError

Create⁠

POSThttps://api.akter.dev/v1/organizations/{organization}/apps/{app}/builds
builds.createBearer token

Register a build by its SHA-256 digest, size and manifest, and get where to upload its bundle when it is not stored yet. akter deploy does this for you.

Path parameters

  • appstringrequired

    An app's name, unique within its organization. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • organizationstringrequired

    An organization's name, unique across Akter Cloud. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

Request bodyCreateBuild

  • digeststringrequired

    A SHA-256 digest as 64 lowercase hex characters.

  • manifestBuildManifestrequired

    build.json: the actor types, contract hashes and migrations of a build.

  • manifest.actorsBuildActor[]required
  • manifest.actors[].contractstringrequired

    The SHA-256 of the actor's entry in contracts.json.

  • manifest.actors[].migrationsBuildMigration[]required
  • manifest.actors[].namestringrequired
  • manifest.actors[].staleForMsRecord<string, integer>

    Each query that declares staleFor, by name. A query not listed, or a build without the field, is always fresh.

  • sizeintegerrequired

    The build's size in bytes.

Response 201CreatedBuild

  • buildBuildrequired
  • build.appstringrequired

    An app's name, unique within its organization. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • build.createdAtstringrequired
  • build.digeststringrequired

    A SHA-256 digest as 64 lowercase hex characters.

  • build.idstringrequired

    An opaque id that starts with bld_.

  • build.manifestBuildManifestrequired

    build.json: the actor types, contract hashes and migrations of a build.

  • build.manifest.actorsBuildActor[]required
  • build.sizeintegerrequired

    The build's size in bytes.

  • build.status"Uploading" | "Building" | "Ready" | "Failed"required
  • uploadBuildUpload

    Absent when the app already stores a build with this digest.

  • upload.expiresAtstringrequired
  • upload.headersRecord<string, string>required

    Send these headers with the PUT.

  • upload.urlstringrequired

    PUT the build here before expiresAt.

Errors

  • 401UnauthorizedError
  • 403ForbiddenError
  • 404NotFoundError | FeatureNotEnabledError
  • 503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError

Get⁠

GEThttps://api.akter.dev/v1/organizations/{organization}/apps/{app}/builds/{build}
builds.getBearer token

Read one build and its status: Uploading, Building, Ready or Failed.

Path parameters

  • appstringrequired

    An app's name, unique within its organization. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • organizationstringrequired

    An organization's name, unique across Akter Cloud. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • buildstringrequired

    An opaque id that starts with bld_.

Response 200Build

  • appstringrequired

    An app's name, unique within its organization. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • createdAtstringrequired
  • digeststringrequired

    A SHA-256 digest as 64 lowercase hex characters.

  • idstringrequired

    An opaque id that starts with bld_.

  • manifestBuildManifestrequired

    build.json: the actor types, contract hashes and migrations of a build.

  • manifest.actorsBuildActor[]required
  • manifest.actors[].contractstringrequired

    The SHA-256 of the actor's entry in contracts.json.

  • manifest.actors[].migrationsBuildMigration[]required
  • manifest.actors[].namestringrequired
  • manifest.actors[].staleForMsRecord<string, integer>

    Each query that declares staleFor, by name. A query not listed, or a build without the field, is always fresh.

  • sizeintegerrequired

    The build's size in bytes.

  • status"Uploading" | "Building" | "Ready" | "Failed"required

Errors

  • 401UnauthorizedError
  • 403ForbiddenError
  • 404NotFoundError | FeatureNotEnabledError
  • 503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError