Skip to main content

List domains

GET /organizations/{organization_id}/domains

Lists all domains.

Parameters

Name Type In Required Description

organization_id

string

path

True

Identifier for an organization.

filter

string

query

False

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

Supported operators:

  • eq - Equality

  • lt/gt - Less than/greater than

  • lte/gte - Less than or equal to/greater than or equal to

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

OpenAPI examples: "field eq 'value'"

skip

string

query

False

Specifies the number of resources to skip when listing a collection.

URL examples: "skip=1"

OpenAPI examples: "1"

include

string

query

False

Specifies which fields should be returned when listing a collection.

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

OpenAPI examples: "id"

limit

string

query

False

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

URL examples: "limit=2"

OpenAPI examples: "2"

orderBy

string

query

False

Indicates the sort order of resources when listing a collection.

URL examples: "orderBy=name", "orderBy=name%20desc"

OpenAPI examples: "name desc"

count

string

query

False

Indicates if the total number of resources should be returned in the response object.

URL examples: "count=true"

OpenAPI examples: "true"

Response

Status: 200, List of domains.
Name Type Required Description

count

integer

False

Total number of resources in the collection that match the query.

items

array[domain_1.0_get_response_body]

True
Example response 
{
  "count": 1,
  "items": [
    {
      "code": "BlueXP133ad2ea-99de-4ada-9be4-876d4d53923e",
      "federations": [
        {
          "id": "4336388b-2992-43af-81de-ba9284b7dc36",
          "name": "Example Co. AD FS"
        },
        {
          "id": "645eae30-ea32-4542-af58-1d9012fed81a",
          "name": "Example Co. SAML"
        }
      ],
      "id": "4336388b-2992-43af-81de-ba9284b7dc36",
      "metadata": {
        "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32",
        "creationTimestamp": "2022-10-06T20:58:16.305662Z",
        "labels": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
        "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32"
      },
      "name": "example.com",
      "organizationId": "9b0ee210-70a0-4158-b025-0decde66e4de",
      "resourceId": "862b6f03-58ac-479b-9ca5-5cb4429d8996",
      "state": "VERIFIED",
      "type": "application/vnd.netapp.bxp.domain",
      "verificationTimestamp": "2024-11-18T20:58:16.305662Z",
      "version": "1.0"
    }
  ]
}

Error

Status: 400, Bad request
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The supplied query parameters are invalid.",
  "status": "400",
  "title": "Invalid query parameters",
  "type": "https://bluexp.netapp.io/problems/1"
}

Error

Status: 401, Unauthorized
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The request is missing the required bearer token.",
  "status": "401",
  "title": "Missing bearer token",
  "type": "https://bluexp.netapp.io/problems/1"
}

Error

Status: 403, Forbidden
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The requested operation isn't permitted.",
  "status": "403",
  "title": "Operation not permitted",
  "type": "https://bluexp.netapp.io/problems/11"
}

Definitions

See Definitions

federations

Name Type Required Description

id

string

False

Globally unique identifier of the resource conforming to the UUIDv4 schema.

name

string

False

The name of the federation.

type_bxp_label

Name/value pair.

Name Type Required Description

name

string

True

Name of the label.

value

string

True

Value of the label.

type_bxp_metadata

Metadata associated with the resource.

Name Type Required Description

createdBy

string

False

UUID of the user who created the resource.

creationTimestamp

string

False

Resource creation date.

labels

array[type_bxp_label]

False

Array of name/value pairs representing additional information for the resource.

modificationTimestamp

string

False

Resource modification date.

modifiedBy

string

False

UUID of the user who modified the resource.

domain_1.0_get_response_body

Name Type Required Description

code

string

False

The unique verification code for this domain.

federations

array[federations]

False

The list of federations that use this domain.

id

string

False

Globally unique identifier of the resource conforming to the UUIDv4 schema.

metadata

type_bxp_metadata

False

Metadata associated with the resource.

name

string

False

The domain name.

organizationId

string

False

Identifier for an organization.

resourceId

string

False

Identifier for the resource.

state

string

False

The state of the domain. Defined values are:

  • "UNVERIFIED" - Ownership of the domain has not been verified.

  • "VERIFIED" - Ownership of the domain has been verified using a DNS TXT record with the verification code.

type

string

False

Media type of the resource.

verificationTimestamp

string

False

The date that the domain was verified.

version

string

False

Version of the resource.

invalidParams

Name Type Required Description

name

string

True

Name of the invalid parameter.

reason

string

True

Reason why the parameter is invalid.