Akter

Organizations

Organizations own members, API keys and apps.

List⁠

GEThttps://api.akter.dev/v1/organizations
organizations.listBearer token

List the organizations the caller belongs to, a page at a time.

Query parameters

  • cursorstring

    The nextCursor of the previous page.

  • limitinteger

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

Response 200OrganizationPage

  • itemsOrganization[]required
  • items[].createdAtstringrequired
  • items[].displayNamestringrequired

    A name for people to read, 1 to 100 characters.

  • items[].namestringrequired

    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.

  • nextCursorstring

    Pass as cursor for the next page.

Errors

  • 401UnauthorizedError
  • 503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError

Create⁠

POSThttps://api.akter.dev/v1/organizations
organizations.createBearer token

Create an organization with a unique name; the caller becomes its owner.

Request bodyCreateOrganization

  • displayNamestringrequired

    A name for people to read, 1 to 100 characters.

  • namestringrequired

    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.

Response 201Organization

  • createdAtstringrequired
  • displayNamestringrequired

    A name for people to read, 1 to 100 characters.

  • namestringrequired

    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.

Errors

  • 401UnauthorizedError
  • 409AlreadyExistsError
  • 503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError

Get⁠

GEThttps://api.akter.dev/v1/organizations/{organization}
organizations.getBearer token

Read one organization by name.

Path parameters

  • 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.

Response 200Organization

  • createdAtstringrequired
  • displayNamestringrequired

    A name for people to read, 1 to 100 characters.

  • namestringrequired

    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.

Errors

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

Update⁠

PATCHhttps://api.akter.dev/v1/organizations/{organization}
organizations.updateBearer tokenSafe to retry

Rename an organization's display name. Its name, used in every path, never changes.

Path parameters

  • 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 bodyUpdateOrganization

  • displayNamestringrequired

    A name for people to read, 1 to 100 characters.

Response 200Organization

  • createdAtstringrequired
  • displayNamestringrequired

    A name for people to read, 1 to 100 characters.

  • namestringrequired

    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.

Errors

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

Delete⁠

DELETEhttps://api.akter.dev/v1/organizations/{organization}
organizations.deleteBearer token

Delete an organization that has no apps left: its API keys are revoked, its invitations dropped and its members removed, and its name can't be used again. Only an owner can, and a person confirms it.

Path parameters

  • 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.

Response 204<No Content>

Errors

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