Snapshots
Named snapshots of an environment's data, each kept until it or its environment is deleted and billed by size.
List
https://api.akter.dev/v1/organizations/{organization}/apps/{app}/environments/{environment}/snapshotsList an environment's snapshots in name order, a page at a time, with their status.
Path parameters
appstringrequiredAn 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.
organizationstringrequiredAn 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.
environmentstringrequiredAn 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.
Query parameters
cursorstringThe nextCursor of the previous page.
limitintegerAt most this many items, 1 to 100. Defaults to 50.
Response 200SnapshotPage
itemsSnapshot[]requireditems[].createdAtstringrequireditems[].environmentstringrequiredAn 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[].namestringrequiredA named snapshot of an environment, such as before-migration, unique within the environment. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.
items[].reasonstringWhy a Failed snapshot was not taken.
items[].sizeBytesintegerThe environment's data size when the snapshot was taken, which it is billed by.
items[].status"Pending" | "Ready" | "Failed" | "Retired"requiredPending: the checkpoint is being taken. Ready: it holds the environment's data as of takenAt. Failed: no snapshot was taken; reason says why. Retired: it was deleted and can't be used, but the storage provider keeps its data until it can be removed.
items[].takenAtstringnextCursorstringPass as cursor for the next page.
Errors
401UnauthorizedError403ForbiddenError404NotFoundError | FeatureNotEnabledError503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError
Create
https://api.akter.dev/v1/organizations/{organization}/apps/{app}/environments/{environment}/snapshotsSnapshot the environment's data now, as of the moment it is taken; writes keep running meanwhile. It answers Pending, and get shows it Ready once taken, usually within seconds. A name already in use fails with AlreadyExistsError, a deleted environment with InUseError (environmentRetired), and a full environment with SnapshotLimitError.
Path parameters
appstringrequiredAn 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.
organizationstringrequiredAn 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.
environmentstringrequiredAn 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.
Request bodyCreateSnapshot
namestringrequiredA named snapshot of an environment, such as before-migration, unique within the environment. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.
Response 202Snapshot
createdAtstringrequiredenvironmentstringrequiredAn 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.
namestringrequiredA named snapshot of an environment, such as before-migration, unique within the environment. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.
reasonstringWhy a Failed snapshot was not taken.
sizeBytesintegerThe environment's data size when the snapshot was taken, which it is billed by.
status"Pending" | "Ready" | "Failed" | "Retired"requiredPending: the checkpoint is being taken. Ready: it holds the environment's data as of takenAt. Failed: no snapshot was taken; reason says why. Retired: it was deleted and can't be used, but the storage provider keeps its data until it can be removed.
takenAtstring
Errors
401UnauthorizedError403ForbiddenError404NotFoundError | FeatureNotEnabledError409AlreadyExistsError | InUseError | SnapshotLimitError503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError
Get
https://api.akter.dev/v1/organizations/{organization}/apps/{app}/environments/{environment}/snapshots/{snapshot}Read one snapshot: its status and, once taken, when and at what size.
Path parameters
appstringrequiredAn 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.
organizationstringrequiredAn 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.
environmentstringrequiredAn 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.
snapshotstringrequiredA named snapshot of an environment, such as before-migration, unique within the environment. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.
Response 200Snapshot
createdAtstringrequiredenvironmentstringrequiredAn 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.
namestringrequiredA named snapshot of an environment, such as before-migration, unique within the environment. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.
reasonstringWhy a Failed snapshot was not taken.
sizeBytesintegerThe environment's data size when the snapshot was taken, which it is billed by.
status"Pending" | "Ready" | "Failed" | "Retired"requiredPending: the checkpoint is being taken. Ready: it holds the environment's data as of takenAt. Failed: no snapshot was taken; reason says why. Retired: it was deleted and can't be used, but the storage provider keeps its data until it can be removed.
takenAtstring
Errors
401UnauthorizedError403ForbiddenError404NotFoundError | FeatureNotEnabledError503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError
Delete
https://api.akter.dev/v1/organizations/{organization}/apps/{app}/environments/{environment}/snapshots/{snapshot}Delete a snapshot: it can no longer be used, it is no longer billed, and its name is free again. The storage provider keeps its data until it can be removed, and it still counts toward the environment's snapshot limit. An API key needs a person's approval token in the akter-approval header.
Path parameters
appstringrequiredAn 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.
organizationstringrequiredAn 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.
environmentstringrequiredAn 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.
snapshotstringrequiredA named snapshot of an environment, such as before-migration, unique within the environment. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.
Response 200Snapshot
createdAtstringrequiredenvironmentstringrequiredAn 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.
namestringrequiredA named snapshot of an environment, such as before-migration, unique within the environment. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.
reasonstringWhy a Failed snapshot was not taken.
sizeBytesintegerThe environment's data size when the snapshot was taken, which it is billed by.
status"Pending" | "Ready" | "Failed" | "Retired"requiredPending: the checkpoint is being taken. Ready: it holds the environment's data as of takenAt. Failed: no snapshot was taken; reason says why. Retired: it was deleted and can't be used, but the storage provider keeps its data until it can be removed.
takenAtstring
Errors
401UnauthorizedError403ForbiddenError404NotFoundError | FeatureNotEnabledError428ConfirmationRequiredError503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError