Akter

Domains

Custom hostnames that serve an app's environment, pointed at Akter with a CNAME.

List⁠

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

List an app's claimed hostnames in name order, a page at a time, with their status.

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 200DomainPage

  • itemsDomain[]required
  • items[].cname"customers.akter.run"required
  • items[].environmentstringrequired

    An environment of an app, such as prod or pr-42. Each environment has its own store. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • items[].hostnamestringrequired

    A hostname you own, such as app.example.com. Names under akter.run are Akter's own.

  • items[].status"Pending" | "Active" | "Removing"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}/domains
domains.createBearer token

Claim a customer hostname for an environment; the response names the CNAME to add at the DNS provider.

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 bodyCreateDomain

  • environmentstringrequired

    An environment of an app, such as prod or pr-42. Each environment has its own store. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • hostnamestringrequired

    A hostname you own, such as app.example.com. Names under akter.run are Akter's own.

Response 202Domain

  • cname"customers.akter.run"required
  • environmentstringrequired

    An environment of an app, such as prod or pr-42. Each environment has its own store. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • hostnamestringrequired

    A hostname you own, such as app.example.com. Names under akter.run are Akter's own.

  • status"Pending" | "Active" | "Removing"required

Errors

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

Get⁠

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

Read a claimed hostname and its status: Pending, Active or Removing.

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.

  • hostnamestringrequired

    A hostname you own, such as app.example.com. Names under akter.run are Akter's own.

Response 200Domain

  • cname"customers.akter.run"required
  • environmentstringrequired

    An environment of an app, such as prod or pr-42. Each environment has its own store. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • hostnamestringrequired

    A hostname you own, such as app.example.com. Names under akter.run are Akter's own.

  • status"Pending" | "Active" | "Removing"required

Errors

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

Delete⁠

DELETEhttps://api.akter.dev/v1/organizations/{organization}/apps/{app}/domains/{hostname}
domains.deleteBearer token

Release a claimed hostname; it stops serving the app.

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.

  • hostnamestringrequired

    A hostname you own, such as app.example.com. Names under akter.run are Akter's own.

Response 202<No Content>

Errors

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