Endpoint

/v1/nexus/registration

GET

Retrieve current Nexus registration status

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "nexus_registration_status",
  "type": "object",
  "properties": {
    "nexus_enabled": {
      "description": "nexus_enabled",
      "type": "boolean"
    },
    "registration_status": {
      "type": "string",
      "enum": [
        "NONE",
        "PENDING_REGISTRATION",
        "ERROR_REGISTERING",
        "REGISTERED"
      ],
      "description": "registration_status:\n * `ERROR_REGISTERING` - ERROR_REGISTERING,\n * `NONE` - NONE,\n * `PENDING_REGISTRATION` - PENDING_REGISTRATION,\n * `REGISTERED` - REGISTERED"
    },
    "secret_created_at": {
      "description": "secret_created_at",
      "type": "string"
    }
  }
}

PUT

Register cluster with Nexus using a join key

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "nexus_registration_put",
  "type": "object",
  "properties": {
    "join_key": {
      "description": "join_key",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "nexus_registration_status",
  "type": "object",
  "properties": {
    "nexus_enabled": {
      "description": "nexus_enabled",
      "type": "boolean"
    },
    "registration_status": {
      "type": "string",
      "enum": [
        "NONE",
        "PENDING_REGISTRATION",
        "ERROR_REGISTERING",
        "REGISTERED"
      ],
      "description": "registration_status:\n * `ERROR_REGISTERING` - ERROR_REGISTERING,\n * `NONE` - NONE,\n * `PENDING_REGISTRATION` - PENDING_REGISTRATION,\n * `REGISTERED` - REGISTERED"
    },
    "secret_created_at": {
      "description": "secret_created_at",
      "type": "string"
    }
  }
}

DELETE

Forget current Nexus registration secrets

Parameters

Name Description Required
If-Match ETag for expected version No

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "nexus_registration_status",
  "type": "object",
  "properties": {
    "nexus_enabled": {
      "description": "nexus_enabled",
      "type": "boolean"
    },
    "registration_status": {
      "type": "string",
      "enum": [
        "NONE",
        "PENDING_REGISTRATION",
        "ERROR_REGISTERING",
        "REGISTERED"
      ],
      "description": "registration_status:\n * `ERROR_REGISTERING` - ERROR_REGISTERING,\n * `NONE` - NONE,\n * `PENDING_REGISTRATION` - PENDING_REGISTRATION,\n * `REGISTERED` - REGISTERED"
    },
    "secret_created_at": {
      "description": "secret_created_at",
      "type": "string"
    }
  }
}