List all licenses

10/23/2024 Contributors

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

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" example: id,product
limit	string	query	False	Indicates the maximum number of resources to return when listing a collection. URL examples: "limit=2" OpenAPI examples: "2"
filter	string	query	False	Indicates which fields should be matched in order to return a resource when listing a collection. Supported operators are: eq - Equality lt/gt - Less than/Greater than lte/gte - Less than or equals to/Greater than or equals to URL example: "filter=field%20eq%20%27value%27" OpenAPI examples: "field eq 'value'"

Name

Type

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"

example: id,product

limit

string

query

False

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

URL examples: "limit=2"

OpenAPI examples: "2"

filter

string

query

False

Indicates which fields should be matched in order to return a resource when listing a collection.

Supported operators are:

eq - Equality
lt/gt - Less than/Greater than
lte/gte - Less than or equals to/Greater than or equals to

URL example: "filter=field%20eq%20%27value%27"

OpenAPI examples: "field eq 'value'"

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: license_1.0_get_response_body, array[]]	True
metadata	type_astra_metadata_list	True

Name

Type

Required

Description

items

array[Any of: license_1.0_get_response_body, array[]]

True

metadata

type_astra_metadata_list

True

Example response

{
  "type": "application/astra-licenses",
  "version": "1.0",
  "items": [
    [
      "c8aa757a-5318-489f-8134-a2a1a6956a3e",
      "Astra SDS"
    ],
    [
      "0f7cc03d-9afc-4192-af7f-b29ab24f8f2a",
      "Astra Enterprise"
    ]
  ],
  "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	True
status	string	True
correlationID	string	False

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

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

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

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

addons

Name	Type	Required	Description
startDate	string	False	JSON string containing a timestamp indicating when this add-on becomes valid. Defined values are: Conforms to the ISO-8601 Date Time Schema
endDate	string	False	JSON string containing a timestamp indicating when this add-on is no longer valid. Defined values are: Conforms to the ISO-8601 Date Time Schema
features	string	False	JSON string containing the list of features associated with this add-on. Defined values are: String contents not validated by the schema.
capacity	string	False	JSON string containing the capacity extracted from the add-on. Defined values are: String contents not validated by the schema
licenseProtocol	string	False	JSON string containing the license protocol associated with this add-on. Defined values are: String contents not validated by the schema

Name

Type

Required

Description

startDate

string

False

JSON string containing a timestamp indicating when this add-on becomes valid. Defined values are:

Conforms to the ISO-8601 Date Time Schema

endDate

string

False

JSON string containing a timestamp indicating when this add-on is no longer valid. Defined values are:

Conforms to the ISO-8601 Date Time Schema

features

string

False

JSON string containing the list of features associated with this add-on. Defined values are:

String contents not validated by the schema.

capacity

string

False

JSON string containing the capacity extracted from the add-on. Defined values are:

String contents not validated by the schema

licenseProtocol

string

False

JSON string containing the license protocol associated with this add-on. Defined values are:

String contents not validated by the schema

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_update

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. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

Name	Type	Required
labels	array[type_astra_label]	False
creationTimestamp	string	False
modificationTimestamp	string	False
createdBy	string	False
modifiedBy	string	False

Name

Type

Required

Description

labels

array[type_astra_label]

False

creationTimestamp

string

False

modificationTimestamp

string

False

createdBy

string

False

modifiedBy

string

False

license_1.0_get_response_body

Name	Type	Required	Description
type	string	True	Media type of the resource. Defined values are: "application/astra-license"
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
allocation	string	False	JSON string containing an ID indicating what the license is allocated to. Only present when the license is allocated. For Astra Control Center licenses, this field must be populated with the account ID and must match the account ID specified in the POST URI. Defined values are: Conforms to the Astra Identifier Schema
hostID	string	False	JSON string containing a host identifier that a license is bound to. Only present if the license is host-locked. Defined values are: Minimum length: 1 Maximum length: 63
deviceCredentialID	string	False	JSON string containing the identifier of the deviceCredential associated with the Credential API. Only present for Astra Data Store licenses. Defined value are: Conforms to the Astra Identifier Schema
isEvaluation	string	True	JSON string indicating whether the license is an evaluation license. Defined values are: "true" "false"
licenseProtocol	string	True	JSON string containing the license protocol extracted from the license. Defined values are: String contents not validated by the schema
licenseText	string	True	JSON string containing a base64 encoded representation of the license JSON as obtained from the NetApp license system. This must be provided in the original byte-level order to allow signature verification. Defined values are: Conforms to the base64 Encoded Data Schema
validFromTimestamp	string	True	JSON string containing a timestamp indicating when the license becomes valid. Defined values are: Conforms to the ISO-8601 Date Time Schema
validUntilTimestamp	string	True	JSON string containing a timestamp indicating when the license is no longer valid. Defined values are: Conforms to the ISO-8601 Date Time Schema
product	string	True	JSON string containing the product string extracted from the license. Defined values are: String contents not validated by the schema
productVersion	string	True	JSON string containing the version string extracted from the license. Defined values are: String contents not validated by the schema
productSN	string	True	JSON string containing the serial number string extracted from the license. Defined values are: String contents not validated by the schema
features	string	True	JSON string containing the package value extracted from the license. Defined values are: String contents not validated by the schema
capacity	string	True	JSON string containing the capacity extracted from the license.
capacity2	string	True	JSON string containing the secondary capacity extracted from the license.
addons	array[addons]	False	JSON array of JSON objects containing the list of add-ons from the license. An add-on is a change in license occurring at a potential future date.
metadata	type_astra_metadata_update	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. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

Name

Type

Required

Description

type

string

True

Media type of the resource. Defined values are:

"application/astra-license"

version

string

True

Version of the resource. Defined values are:

"1.0"

string

True

Globally unique identifier of the resource. Defined values are:

Conforms to the UUIDv4 Schema

allocation

string

False

JSON string containing an ID indicating what the license is allocated to. Only present when the license is allocated. For Astra Control Center licenses, this field must be populated with the account ID and must match the account ID specified in the POST URI. Defined values are:

Conforms to the Astra Identifier Schema

hostID

string

False

JSON string containing a host identifier that a license is bound to. Only present if the license is host-locked. Defined values are:

Minimum length: 1
Maximum length: 63

deviceCredentialID

string

False

JSON string containing the identifier of the deviceCredential associated with the Credential API. Only present for Astra Data Store licenses. Defined value are:

Conforms to the Astra Identifier Schema

isEvaluation

string

True

JSON string indicating whether the license is an evaluation license. Defined values are:

"true"
"false"

licenseProtocol

string

True

JSON string containing the license protocol extracted from the license. Defined values are:

String contents not validated by the schema

licenseText

string

True

JSON string containing a base64 encoded representation of the license JSON as obtained from the NetApp license system. This must be provided in the original byte-level order to allow signature verification. Defined values are:

Conforms to the base64 Encoded Data Schema

validFromTimestamp

string

True

JSON string containing a timestamp indicating when the license becomes valid. Defined values are:

Conforms to the ISO-8601 Date Time Schema

validUntilTimestamp

string

True

JSON string containing a timestamp indicating when the license is no longer valid. Defined values are:

Conforms to the ISO-8601 Date Time Schema

product

string

True

JSON string containing the product string extracted from the license. Defined values are:

String contents not validated by the schema

productVersion

string

True

JSON string containing the version string extracted from the license. Defined values are:

String contents not validated by the schema

productSN

string

True

JSON string containing the serial number string extracted from the license. Defined values are:

String contents not validated by the schema

features

string

True

JSON string containing the package value extracted from the license. Defined values are:

String contents not validated by the schema

capacity

string

True

JSON string containing the capacity extracted from the license.

capacity2

string

True

JSON string containing the secondary capacity extracted from the license.

addons

array[addons]

False

JSON array of JSON objects containing the list of add-ons from the license. An add-on is a change in license occurring at a potential future date.

metadata

type_astra_metadata_update

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. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

type_astra_metadata_list

Name	Type	Required
continue	string	False
count	number	False
labels	array[type_astra_label]	False
creationTimestamp	string	False
modificationTimestamp	string	False
createdBy	string	False
modifiedBy	string	False

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

Name

Type

Required

Description

name

string

True

Name of the invalid query parameter

reason

string

True

Reason why the query parameter is invalid

List all licenses

Creating your file...

Parameters

Response

Response

Response

Response

Error

Definitions