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

List all ASUP resources

Contributors
PDFs

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

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

include

string

query

False

Indicates which fields should be returned when listing a collection.

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

OpenAPI examples: "id"

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: asup_1.0_get_response_body, array[]]

True

metadata

type_astra_metadata_list

True
Example response 
{
  "type": "application/astra-asups",
  "version": "1.0",
  "items": [
    {
      "type": "application/astra-asup",
      "version": "1.0",
      "id": "80796606-79ba-480b-966c-e4c600fbf623",
      "creationState": "completed",
      "creationStateDetails": [],
      "upload": "true",
      "uploadState": "running",
      "uploadStateDetails": [],
      "triggerType": "manual",
      "dataWindowStart": "2020-08-05T12:24:00.000000Z",
      "dataWindowEnd": "2020-08-06T12:24:52.000000Z",
      "metadata": {
        "labels": [],
        "creationTimestamp": "2020-08-06T12:24:52.256624Z",
        "modificationTimestamp": "2020-08-06T12:24:52.256624Z",
        "createdBy": "1b32a508-cc6f-4f1b-809f-c42fd91b4848"
      }
    },
    {
      "type": "application/astra-asup",
      "version": "1.0",
      "id": "6503131d-8b36-4434-b34f-73661ae8100b",
      "creationState": "completed",
      "creationStateDetails": [],
      "upload": "true",
      "uploadState": "completed",
      "uploadStateDetails": [],
      "triggerType": "scheduled",
      "dataWindowStart": "2020-08-04T13:30:00.000000Z",
      "dataWindowEnd": "2020-08-05T13:30:00.000000Z",
      "metadata": {
        "labels": [],
        "creationTimestamp": "2020-08-05T13:30:00.012321Z",
        "modificationTimestamp": "2020-08-05T13:30:00.012321Z",
        "createdBy": "1b32a508-cc6f-4f1b-809f-c42fd91b4848"
      }
    }
  ],
  "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

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

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

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

Name Type Required Description

type

string

True

title

string

True

detail

string

True

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

asup_1.0_get_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_stateDetails]

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

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.

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