Sign in
Provider

Update a provider

Updates a provider by ID

patch/provider/{id}

Path parameters

idstring uuid required

Unique identifier for the entity represented as a UUID

Request body

attributesobject

Provider-specific attributes defined in the specification schema

Example request

{
  "attributes": {
    "cluster": {
      "id": "my-np-gcp-prod",
      "location": "s-west1",
      "namespace": "my-namespace"
    },
    "gateway": {
      "public_name": "my-public-gateway",
      "private_name": "my-private-gateway"
    }
  },
  "tags": [
    {
      "key": "cluster.id",
      "value": "my-np-gcp-prod"
    }
  ]
}

Response

Object representing a provider resource

idstring uuid required

Unique identifier for the entity represented as a UUID

nrnstring required

Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources

specification_idstring uuid required

Unique identifier for the entity represented as a UUID

attributesobject required

Provider-specific attributes defined in the specification schema

dimensionsobject

NRN-specific dimensions. Read more

groupsstring[]

Groups associated with the provider

created_atstring date-time required

Creation timestamp

updated_atstring date-time required

Last update timestamp

Example response

{
  "id": "a3f1c2d4-e5b6-7890-ab12-cdef34567890",
  "nrn": "organization=1:account=1:namespace=1",
  "dimensions": {
    "environment": "production"
  },
  "specification_id": "02fd22f1-6bf9-41aa-9b58-29d50f725855",
  "attributes": {
    "cluster": {
      "id": "my-np-gcp-prod",
      "location": "s-west1",
      "namespace": "my-namespace"
    },
    "gateway": {
      "public_name": "my-public-gateway",
      "private_name": "my-private-gateway"
    }
  },
  "tags": [
    {
      "id": "4e2306de-82e3-4b74-a419-e0e324beb500",
      "key": "cluster.id",
      "value": "my-np-gcp-prod"
    }
  ],
  "created_at": "2024-10-15T08:30:00Z",
  "updated_at": "2024-10-20T14:45:00Z"
}

Changes