Skip to main content

List the application snapshots for an app

Contributors
PDFs

GET /accounts/{account_id}/k8s/v1/apps/{app_id}/appSnaps

Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.

Parameters

Name Type In Required Description

account_id

string

path

True

ID of the containing account resource

  • example: {{.Account}}

app_id

string

path

True

ID of the containing app resource

include

string

query

False

Indicates which fields should be returned when listing a collection.

URL examples: "include=id", "include=id,name"

OpenAPI examples: "id"

  • example: id,name,state

limit

string

query

False

Indicates the maximum number of resources to return when listing a collection.

URL examples: "limit=2"

OpenAPI examples: "2"

Response

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
Name Type Required Description

items

array[Any of: appSnap_1.3_get_response_body, array[]]

True

metadata

type_astra_metadata_list

True
Example response 
{
  "type": "application/astra-appSnaps",
  "version": "1.3",
  "items": [
    [
      "2b6dafc3-2172-4431-a482-6306b2703130",
      "app-name-245",
      "pending"
    ],
    [
      "6fd9b31a-3924-4c9a-878b-175fa9538b8c",
      "app-name-244",
      "completed"
    ]
  ],
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Response

Status: 401, Unauthorized
Name Type Required Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False
Example response 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Response

Status: 400, Bad request
Name Type Required Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False

invalidParams

array[invalidParams]

False

List of invalid query parameters
Example response 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Response

Status: 403, Forbidden
Name Type Required Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False
Example response 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Error

Status: 404, Not found
Name Type Required Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False
Example error response 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Definitions

See Definitions

additionalDetails

type_astra_stateDetail

Name Type Required Description

type

string

True

title

string

True

detail

string

True

additionalDetails

additionalDetails

False

type_astra_label

Name Type Required Description

name

string

True

value

string

True

type_astra_metadata

Client and service-specified metadata associated with the resource. Defined values are:

  • Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels.

Name Type Required Description

labels

array[type_astra_label]

True

creationTimestamp

string

True

modificationTimestamp

string

True

createdBy

string

True

modifiedBy

string

False

appSnap_1.3_get_response_body

Name Type Required Description

type

string

True

Media type of the resource. Defined values are:

  • "application/astra-appSnap"

version

string

True

Version of the resource. Defined values are:

  • "1.0"

  • "1.1"

  • "1.2"

  • "1.3"

id

string

True

Globally unique identifier of the resource. Defined values are:

  • Conforms to the UUIDv4 Schema

name

string

True

JSON string containing a user-specified name for the snapshot. If not specified, or when snapshots are initiated by a schedule, the system assigns a name for the snapshot. Defined values are:

  • Minimum length: 1

  • Maximum length: 63

  • Conforms to the DNS 1123 Label Schema

bucketID

string

False

JSON string containing an optional bucket ID that indicates where the snapshot will be stored on create. If not specified, a default bucket on the cluster is used. If no default bucket is specified on the cluster, the corresponding cloud default bucket will be used. If the cloud default bucket is not available, an error will be returned on create. Defined values are:

  • Conforms to the Astra Identifier Schema

scheduleID

string

False

JSON string containing an optional schedule ID that indicates that the snapshot was triggered by a schedule and specifies which schedule triggered the snapshot. Only present for snapshots initiated by a schedule. Defined values are:

  • Conforms to the Astra Identifier Schema

snapshotAppAsset

string

False

JSON string containing the ID of the application asset corresponding to the snapshot. This field will be returned when the state of the application snapshot is "completed". Defined values are:

  • Conforms to the Astra Identifier Schema

state

string

True

JSON string containing a value indicating the operational state of the snapshot. Defined values are:

  • "pending" - The application snapshot is scheduled for discovery

  • "discovering" - The application snapshot is in the process of being discovered

  • "running" - The application snapshot is running normally

  • "completed" - The application snapshot has completed

  • "failed" - The application snapshot is in a permanent failure state

  • "removed" - The application snapshot is not currently accessible

  • "deleting" - The application snapshot is being deleted

  • "unknown" - The application snapshot state cannot be determined

stateUnready

array[string]

True

JSON array of JSON strings, each indicating a reason why an application snapshot is unable to transition to "running", or why it has transitioned to "failed". Defined values are:

  • Minimum length: 1

  • Maximum length: 127

stateDetails

array[type_astra_stateDetail]

False

JSON array of JSON objects which lists additional details about the current state, including why the current state was reached. If no details are available, this array will be empty. Defined values are:

  • Minimum Items: 0

hookState

string

False

JSON string containing a value indicating the state of any execution hook or hooks running as a part of a snapshot. Defined values are:

  • "failed" - One or more execution hooks have failed

  • "success" - There were zero or more applicable hooks and all were successful

hookStateDetails

array[type_astra_stateDetail]

False

JSON array of JSON objects which lists additional details about why "hookState" transitioned into "failed". If no details are available, this array will be empty.

  • Minimum items: 0

metadata

type_astra_metadata

True

Client and service-specified metadata associated with the resource. Defined values are:

  • Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels.

type_astra_metadata_list

Name Type Required Description

continue

string

False

count

number

False

labels

array[type_astra_label]

False

creationTimestamp

string

False

modificationTimestamp

string

False

createdBy

string

False

modifiedBy

string

False

invalidParams

Name Type Required Description

name

string

True

Name of the invalid query parameter

reason

string

True

Reason why the query parameter is invalid