Create a new application snapshot for an app

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

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

Request Body

Indicates the desired values for the Application Snapshot API resource to be created.

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"
name	string	False	JSON string containing a user-specified name for the snapshot. If not specified, or when snapshots are initiated by a schedule, the system will assign a name for the snapshot. Defined values are: Minimum length: 1 Maximum length: 63 Conforms to the DNS 1123 Label Schema
metadata	type_astra_metadata	False	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

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"

name

string

False

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

Minimum length: 1
Maximum length: 63
Conforms to the DNS 1123 Label Schema

metadata

type_astra_metadata

False

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.

Example request

{
  "type": "application/astra-appSnap",
  "version": "1.1",
  "name": "app-name-245"
}

Response

Status: 201, Returns the newly created appSnap resource in the JSON 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"
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 will assign a name for the snapshot. Defined values are: Minimum length: 1 Maximum length: 63 Conforms to the DNS 1123 Label Schema
scheduleID	string	False	JSON string containing an optional schedule ID that indicates that the snapshot was triggered by a schedule and 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 "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
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_stateDetails]	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.

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"

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 will assign a name for the snapshot. Defined values are:

Minimum length: 1
Maximum length: 63
Conforms to the DNS 1123 Label Schema

scheduleID

string

False

JSON string containing an optional schedule ID that indicates that the snapshot was triggered by a schedule and 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
"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

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_stateDetails]

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.

Example response

{
  "type": "application/astra-appSnap",
  "version": "1.1",
  "id": "ab41abde-ae1b-5361-ae00-d82deac97bf3",
  "name": "app-name-245",
  "scheduleID": "1fe83650-9b3c-41ef-bb25-a2910c19c33e",
  "state": "pending",
  "stateUnready": [],
  "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
type	string	True
title	string	True
detail	string	False
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

False

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	False
status	string	True
correlationID	string	False
invalidFields	array[invalidFields]	False	List of invalid request body fields

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False

invalidFields

array[invalidFields]

False

List of invalid request body fields

Example response

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

Response

Status: 409, Conflict

Name	Type	Required	Description
type	string	True
title	string	True
detail	string	False
status	string	True
correlationID	string	False
invalidFields	array[invalidFields]	False	List of invalid request body fields

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False

invalidFields

array[invalidFields]

False

List of invalid request body fields

Example response

{
  "type": "https://astra.netapp.io/problems/10",
  "title": "JSON resource conflict",
  "detail": "The request body JSON contains a field that conflicts with an idempotent value.",
  "status": "409"
}

Response

Status: 403, Forbidden

Name	Type	Required
type	string	True
title	string	True
detail	string	False
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

False

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
type	string	True
title	string	True
detail	string	False
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

False

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

type_astra_label

Name	Type	Required	Description
name	string	True
value	string	True

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
labels	array[type_astra_label]	True
creationTimestamp	string	True
modificationTimestamp	string	True
createdBy	string	True
modifiedBy	string	False

Name

Type

Required

Description

labels

array[type_astra_label]

True

creationTimestamp

string

True

modificationTimestamp

string

True

createdBy

string

True

modifiedBy

string

False

type_astra_stateDetails

Name	Type	Required
type	string	True
title	string	True
detail	string	True

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

invalidParams

Name	Type	Required	Description
name	string	True	Name of the invalid query parameter
reason	string	True	Reason why the query parameter is invalid

Name

Type

Required

Description

name

string

True

Name of the invalid query parameter

reason

string

True

Reason why the query parameter is invalid

invalidFields

Name	Type	Required	Description
name	string	True	Name of the invalid request body field
reason	string	True	Reason why the request body field is invalid

Name

Type

Required

Description

name

string

True

Name of the invalid request body field

reason

string

True

Reason why the request body field is invalid

Create a new application snapshot for an app

Creating your file...

Parameters

Request Body

Response

Response

Response

Response

Response

Error

Definitions