Endpoint

/v1/nexus/connection

GET

Retrieve current Nexus connection configuration

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "nexus_connection_config",
  "type": "object",
  "properties": {
    "nexus_enabled": {
      "description": "nexus_enabled",
      "type": "boolean"
    },
    "nexus_host": {
      "description": "nexus_host",
      "type": "string"
    },
    "nexus_port": {
      "description": "nexus_port",
      "type": "number"
    },
    "nexus_interval": {
      "description": "nexus_interval",
      "type": "number"
    },
    "nexus_capability_remote_support": {
      "description": "nexus_capability_remote_support",
      "type": "boolean"
    },
    "nexus_capability_sso": {
      "description": "nexus_capability_sso",
      "type": "boolean"
    }
  }
}

PUT

Set the Nexus connection configuration

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "nexus_connection_config",
  "type": "object",
  "properties": {
    "nexus_enabled": {
      "description": "nexus_enabled",
      "type": "boolean"
    },
    "nexus_host": {
      "description": "nexus_host",
      "type": "string"
    },
    "nexus_port": {
      "description": "nexus_port",
      "type": "number"
    },
    "nexus_interval": {
      "description": "nexus_interval",
      "type": "number"
    },
    "nexus_capability_remote_support": {
      "description": "nexus_capability_remote_support",
      "type": "boolean"
    },
    "nexus_capability_sso": {
      "description": "nexus_capability_sso",
      "type": "boolean"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "nexus_connection_config",
  "type": "object",
  "properties": {
    "nexus_enabled": {
      "description": "nexus_enabled",
      "type": "boolean"
    },
    "nexus_host": {
      "description": "nexus_host",
      "type": "string"
    },
    "nexus_port": {
      "description": "nexus_port",
      "type": "number"
    },
    "nexus_interval": {
      "description": "nexus_interval",
      "type": "number"
    },
    "nexus_capability_remote_support": {
      "description": "nexus_capability_remote_support",
      "type": "boolean"
    },
    "nexus_capability_sso": {
      "description": "nexus_capability_sso",
      "type": "boolean"
    }
  }
}

PATCH

Partial set of the Nexus connection configuration

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "nexus_connection_config_patch",
  "type": "object",
  "properties": {
    "nexus_enabled": {
      "description": "nexus_enabled",
      "type": "boolean"
    },
    "nexus_host": {
      "description": "nexus_host",
      "type": "string"
    },
    "nexus_port": {
      "description": "nexus_port",
      "type": "number"
    },
    "nexus_interval": {
      "description": "nexus_interval",
      "type": "number"
    },
    "nexus_capability_remote_support": {
      "description": "nexus_capability_remote_support",
      "type": "boolean"
    },
    "nexus_capability_sso": {
      "description": "nexus_capability_sso",
      "type": "boolean"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "nexus_connection_config",
  "type": "object",
  "properties": {
    "nexus_enabled": {
      "description": "nexus_enabled",
      "type": "boolean"
    },
    "nexus_host": {
      "description": "nexus_host",
      "type": "string"
    },
    "nexus_port": {
      "description": "nexus_port",
      "type": "number"
    },
    "nexus_interval": {
      "description": "nexus_interval",
      "type": "number"
    },
    "nexus_capability_remote_support": {
      "description": "nexus_capability_remote_support",
      "type": "boolean"
    },
    "nexus_capability_sso": {
      "description": "nexus_capability_sso",
      "type": "boolean"
    }
  }
}