Akter

Secrets

An environment's secrets: sealed when set, handed only to that environment's hosts and computers, and never returned by the API.

Set⁠

PUThttps://api.akter.dev/v1/organizations/{organization}/apps/{app}/environments/{environment}/secrets/{name}
secrets.setBearer token

Set a secret's value, replacing any earlier value of that name.

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.

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

  • namestringrequired

    A secret's name within an environment, as an environment variable: an uppercase letter, then up to 127 uppercase letters, digits or underscores.

Request bodySetSecret

  • valuestringrequired

    The secret's value, up to 64 KiB. It is sealed at once and never returned.

Response 200AppSecret

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

  • namestringrequired

    A secret's name within an environment, as an environment variable: an uppercase letter, then up to 127 uppercase letters, digits or underscores.

  • updatedAtintegerrequired

    When the value was last set, in milliseconds since the epoch.

  • versionintegerrequired

    Increases each time the value is set.

Errors

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

Delete⁠

DELETEhttps://api.akter.dev/v1/organizations/{organization}/apps/{app}/environments/{environment}/secrets/{name}
secrets.deleteBearer token

Delete a secret; hosts and computers stop receiving it. Deleting a name that is not set succeeds.

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.

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

  • namestringrequired

    A secret's name within an environment, as an environment variable: an uppercase letter, then up to 127 uppercase letters, digits or underscores.

Response 204<No Content>

Errors

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

List⁠

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

List an environment's secret names and when each was set, never their values.

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.

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

Response 200AppSecretList

  • itemsAppSecret[]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[].namestringrequired

    A secret's name within an environment, as an environment variable: an uppercase letter, then up to 127 uppercase letters, digits or underscores.

  • items[].updatedAtintegerrequired

    When the value was last set, in milliseconds since the epoch.

  • items[].versionintegerrequired

    Increases each time the value is set.

Errors

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