Skip to main content
A newer release of this product is available.

Create a new ASUP resource

Contributors

POST /accounts/{account_id}/core/v1/asups

Indicates the desired values for the ASUP API resource to be created.

Parameters

Name Type In Required Description

account_id

string

path

True

ID of the containing account resource

  • example: {{.Account}}

Request Body

Indicates the desired values for the ASUP API resource to be created.

Name Type Required Description

type

string

True

Media type of the resource. Defined values are:

  • "application/astra-asup"

version

string

True

Version of the resource. Defined values are:

  • "1.0"

upload

string

True

JSON string containing a value indicating whether to upload the AutoSupport bundle after successful creation. Defined values are:

  • "true" - Upload the AutoSupport bundle.

  • "false" - Do not upload the AutoSupport bundle.

dataWindowStart

string

False

JSON string containing a timestamp indicating the start time of the AutoSupport bundle data collection window. Defaults to 24 hours before the "dataWindowEnd" key value. Must occur before the "dataWindowEnd" key value. Maximum is 7 days before the current time of the request. Defined values are:

  • Conforms to the ISO-8601 Date Time Schema

dataWindowEnd

string

False

JSON string containing a timestamp indicating the end time of the AutoSupport bundle data collection window. Defaults to the current time of the request. Defined values are:

  • Conforms to the ISO-8601 Date Time 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-asup",
  "version": "1.0",
  "upload": "true"
}

Response

Status: 201, Returns the newly created asup resource in the JSON response body.
Name Type Required Description

type

string

True

Media type of the resource. Defined values are:

  • "application/astra-asup"

version

string

True

Version of the resource. Defined values are:

  • "1.0"

id

string

True

Globally unique identifier of the resource. Defined values are:

  • Conforms to the UUIDv4 Schema

creationState

string

True

JSON string containing a value indicating the creation state of the AutoSupport bundle. For "completed" and "partial" states, the bundle can be downloaded by performing a GET of the resource URI with an Accept header containing "/" or "application/gzip". Defined values are:

  • "running" - AutoSupport bundle generation is running normally.

  • "completed" - AutoSupport bundle generation has completed.

  • "partial" - AutoSupport bundle generation has completed but some data was not included in the bundle.

  • "failed" - AutoSupport bundle generation is in a permanent failure state.

creationStateDetails

array[type_astra_stateDetail]

True

JSON array of JSON objects that lists additional details about why "creationState" transitioned into "partial" or "failed". If no details are available, this array will be empty.

  • Minimum items: 0

upload

string

True

JSON string containing a value indicating whether to upload the AutoSupport bundle after successful creation. Defined values are:

  • "true" - Upload the AutoSupport bundle.

  • "false" - Do not upload the AutoSupport bundle.

uploadState

string

False

JSON string containing a value that indicates the state of the AutoSupport bundle upload if it was requested. Defined values are:

  • "pending" - AutoSupport bundle upload is scheduled for when AutoSupport bundle creation completes ("creationState" is "running").

  • "blocked" - AutoSupport bundle upload was not attempted because the bundle was not created ("creationState" is "failed") or upload was blocked because there is no license.

  • "running" - AutoSupport bundle upload is running normally ("creationState" is "completed" or "partial").

  • "completed" - AutoSupport bundle upload has completed.

  • "failed" - AutoSupport bundle upload is in a permanent failure state.

uploadStateDetails

array[type_astra_stateDetail]

False

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

  • Minimum items: 0

triggerType

string

True

JSON string containing a value that indicates what triggered the creation of the ASUP resource. Defined values are:

  • "manual" - The ASUP resource and associated AutoSupport bundle were created manually.

  • "scheduled" - The ASUP resource and associated AutoSupport bundle were created according to a configured schedule.

dataWindowStart

string

True

JSON string containing a timestamp indicating the start time of the AutoSupport bundle data collection window. Defaults to 24 hours before the "dataWindowEnd" key value. Must occur before the "dataWindowEnd" key value. Maximum is 7 days before the current time of the request. Defined values are:

  • Conforms to the ISO-8601 Date Time Schema

dataWindowEnd

string

True

JSON string containing a timestamp indicating the end time of the AutoSupport bundle data collection window. Defaults to the current time of the request. Defined values are:

  • Conforms to the ISO-8601 Date Time Schema

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-asup",
  "version": "1.0",
  "id": "9950003f-a1c7-5ca7-8930-06eec25f60aa",
  "creationState": "running",
  "creationStateDetails": [],
  "upload": "true",
  "uploadState": "pending",
  "uploadStateDetails": [],
  "triggerType": "manual",
  "dataWindowStart": "2020-08-05T12:24:00.000000Z",
  "dataWindowEnd": "2020-08-06T12:24:52.000000Z",
  "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

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

True

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

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

type_astra_stateDetail

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

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