Create a new ASUP resource
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
|
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:
|
version |
string |
True |
Version of the resource. Defined values are:
|
upload |
string |
True |
JSON string containing a value indicating whether to upload the AutoSupport bundle after successful creation. Defined values are:
|
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:
|
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:
|
metadata |
False |
Client and service-specified metadata associated with the resource. Defined values are:
|
Example request
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:
|
version |
string |
True |
Version of the resource. Defined values are:
|
id |
string |
True |
Globally unique identifier of the resource. Defined values are:
|
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:
|
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.
|
upload |
string |
True |
JSON string containing a value indicating whether to upload the AutoSupport bundle after successful creation. Defined values are:
|
uploadState |
string |
False |
JSON string containing a value that indicates the state of the AutoSupport bundle upload if it was requested. Defined values are:
|
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.
|
triggerType |
string |
True |
JSON string containing a value that indicates what triggered the creation of the asup resource. Defined values are:
|
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:
|
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:
|
metadata |
True |
Client and service-specified metadata associated with the resource. Defined values are:
|
Example response
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
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 |
Example response
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 |
Example response
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
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
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_stateDetails
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 |