Sonatype Nexus Smart Proxy Plugin API

Data

  • Default Namespace
  • XML Schema File: ns0.xsd

The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.

The following elements are members of this namespace:

The following types are members of this namespace:

Element publish-subscribe-request

Example XML

<?xml version="1.0" encoding="UTF-8"?> <publish-subscribe-request> <data> <!--content of type 'publish-subscribe-request'--> <subscribe> <!--content of type 'boolean'--> ... </subscribe> <repositoryId> <!--content of type 'string'--> ... </repositoryId> <publish> <!--content of type 'boolean'--> ... </publish> <preemptiveFetch> <!--content of type 'boolean'--> ... </preemptiveFetch> </data> </publish-subscribe-request>

Example JSON

{ "data" : { "subscribe" : false, "repositoryId" : "...", "publish" : false, "preemptiveFetch" : false } }

Element publish-subscribe-response

Example XML

<?xml version="1.0" encoding="UTF-8"?> <publish-subscribe-response> <data> <!--content of type 'publish-subscribe-response'--> <certificate> <!--content of type 'certificate'--> <fingerprint> <!--content of type 'string'--> ... </fingerprint> <detail> <!--content of type 'string'--> ... </detail> <pem> <!--content of type 'string'--> ... </pem> </certificate> <subscriptionStatus> <!--content of type 'string'--> ... </subscriptionStatus> <publishStatus> <!--content of type 'string'--> ... </publishStatus> <subscribe> <!--content of type 'boolean'--> ... </subscribe> <repositoryId> <!--content of type 'string'--> ... </repositoryId> <publish> <!--content of type 'boolean'--> ... </publish> <preemptiveFetch> <!--content of type 'boolean'--> ... </preemptiveFetch> </data> </publish-subscribe-response>

Example JSON

{ "data" : { "certificate" : { "fingerprint" : "...", "detail" : "...", "pem" : "..." }, "subscriptionStatus" : "...", "publishStatus" : "...", "subscribe" : false, "repositoryId" : "...", "publish" : false, "preemptiveFetch" : false } }

Element settings-request

Example XML

<?xml version="1.0" encoding="UTF-8"?> <settings-request> <data> <!--content of type 'settings-request'--> <trusted-keys> <trusted-key> <!--content of type 'trusted-key'--> <id> <!--content of type 'string'--> ... </id> <certificate> <!--content of type 'string'--> ... </certificate> <description> <!--content of type 'string'--> ... </description> </trusted-key> <trusted-key> <!--(another 'trusted-key' type)--> </trusted-key> <!--...more "trusted-key" elements...--> </trusted-keys> <enabled> <!--content of type 'boolean'--> ... </enabled> <advertiseUri> <!--content of type 'string'--> ... </advertiseUri> <identity> <!--content of type 'certificate'--> <fingerprint> <!--content of type 'string'--> ... </fingerprint> <detail> <!--content of type 'string'--> ... </detail> <pem> <!--content of type 'string'--> ... </pem> </identity> <port> <!--content of type 'int'--> ... </port> <host> <!--content of type 'string'--> ... </host> </data> </settings-request>

Example JSON

{ "data" : { "trusted-keys" : [ { "id" : "...", "certificate" : "...", "description" : "..." }, ... ], "enabled" : false, "advertiseUri" : "...", "identity" : { "fingerprint" : "...", "detail" : "...", "pem" : "..." }, "port" : ..., "host" : "..." } }

Element settings-response

Example XML

<?xml version="1.0" encoding="UTF-8"?> <settings-response> <data> <!--content of type 'settings-response'--> <identity> <!--content of type 'certificate'--> <fingerprint> <!--content of type 'string'--> ... </fingerprint> <detail> <!--content of type 'string'--> ... </detail> <pem> <!--content of type 'string'--> ... </pem> </identity> <status> <!--content of type 'string'--> ... </status> <enabled> <!--content of type 'boolean'--> ... </enabled> <advertiseUri> <!--content of type 'string'--> ... </advertiseUri> <identity> <!--content of type 'certificate'--> <fingerprint> <!--content of type 'string'--> ... </fingerprint> <detail> <!--content of type 'string'--> ... </detail> <pem> <!--content of type 'string'--> ... </pem> </identity> <port> <!--content of type 'int'--> ... </port> <host> <!--content of type 'string'--> ... </host> </data> </settings-response>

Example JSON

{ "data" : { "identity" : { "fingerprint" : "...", "detail" : "...", "pem" : "..." }, "status" : "...", "enabled" : false, "advertiseUri" : "...", "port" : ..., "host" : "..." } }

Element trusted-key-request

Example XML

<?xml version="1.0" encoding="UTF-8"?> <trusted-key-request> <data> <!--content of type 'trusted-key'--> <id> <!--content of type 'string'--> ... </id> <certificate> <!--content of type 'string'--> ... </certificate> <description> <!--content of type 'string'--> ... </description> </data> </trusted-key-request>

Example JSON

{ "data" : { "id" : "...", "certificate" : "...", "description" : "..." } }

Element trusted-key-response

Example XML

<?xml version="1.0" encoding="UTF-8"?> <trusted-key-response> <data> <!--content of type 'trusted-key'--> <description> <!--content of type 'string'--> ... </description> <certificate> <!--content of type 'certificate'--> <fingerprint> <!--content of type 'string'--> ... </fingerprint> <detail> <!--content of type 'string'--> ... </detail> <pem> <!--content of type 'string'--> ... </pem> </certificate> <id> <!--content of type 'string'--> ... </id> </data> </trusted-key-response>

Example JSON

{ "data" : { "description" : "...", "certificate" : { "fingerprint" : "...", "detail" : "...", "pem" : "..." }, "id" : "..." } }

Element trusted-keys-response

Example XML

<?xml version="1.0" encoding="UTF-8"?> <trusted-keys-response> <data> <trusted-key> <!--content of type 'trusted-key'--> <description> <!--content of type 'string'--> ... </description> <certificate> <!--content of type 'certificate'--> <fingerprint> <!--content of type 'string'--> ... </fingerprint> <detail> <!--content of type 'string'--> ... </detail> <pem> <!--content of type 'string'--> ... </pem> </certificate> <id> <!--content of type 'string'--> ... </id> </trusted-key> <trusted-key> <!--(another 'trusted-key' type)--> </trusted-key> <!--...more "trusted-key" elements...--> </data> </trusted-keys-response>

Example JSON

{ "data" : [ { "description" : "...", "certificate" : { "fingerprint" : "...", "detail" : "...", "pem" : "..." }, "id" : "..." }, ... ] }

Type certificate

Child Elements

name (type) min/max
occurs
description
fingerprint (string) 0/1 (no documentation provided)
detail (string) 0/1 (no documentation provided)
pem (string) 0/1 (no documentation provided)

Type configurePublishSubscribeRequestEnvelope

Child Elements

name (type) min/max
occurs
description
data (publish-subscribe-request) 0/1 (no documentation provided)

Type configurePublishSubscribeResponseEnvelope

Child Elements

name (type) min/max
occurs
description
data (publish-subscribe-response) 0/1 (no documentation provided)

Type publish-subscribe

Child Elements

name (type) min/max
occurs
description
subscribe (boolean) 1/1 (no documentation provided)
repositoryId (string) 0/1 (no documentation provided)
publish (boolean) 1/1 (no documentation provided)
preemptiveFetch (boolean) 1/1 (no documentation provided)

Type publish-subscribe-response

Child Elements

name (type) min/max
occurs
description
certificate (certificate) 0/1 (no documentation provided)
subscriptionStatus (string) 0/1 (no documentation provided)
publishStatus (string) 0/1 (no documentation provided)

Type settings

Child Elements

name (type) min/max
occurs
description
enabled (boolean) 0/1 (no documentation provided)
advertiseUri (string) 0/1 (no documentation provided)
identity (certificate) 0/1 (no documentation provided)
port (int) 1/1 (no documentation provided)
host (string) 0/1 (no documentation provided)

Type settings-request

Child Elements

name (type) min/max
occurs
description
trusted-keys/trusted-key (trusted-key) 0/unbounded (no documentation provided)

Type settingsRequestEnvelope

Child Elements

name (type) min/max
occurs
description
data (settings-request) 0/1 (no documentation provided)

Type settings-response

Child Elements

name (type) min/max
occurs
description
identity (certificate) 0/1 (no documentation provided)
status (string) 0/1 (no documentation provided)

Type settingsResponseEnvelope

Child Elements

name (type) min/max
occurs
description
data (settings-response) 0/1 (no documentation provided)

Type trusted-key

Child Elements

name (type) min/max
occurs
description
id (string) 0/1 (no documentation provided)
certificate (string) 0/1 (no documentation provided)
description (string) 0/1 (no documentation provided)

Type trusted-key

Child Elements

name (type) min/max
occurs
description
description (string) 0/1 (no documentation provided)
certificate (certificate) 0/1 (no documentation provided)
id (string) 0/1 (no documentation provided)

Type trustedKeyRequestEnvelope

Child Elements

name (type) min/max
occurs
description
data (trusted-key) 0/1 (no documentation provided)

Type trustedKeyResponseEnvelope

Child Elements

name (type) min/max
occurs
description
data (trusted-key) 0/1 (no documentation provided)

Type trustedKeysResponseEnvelope

Child Elements

name (type) min/max
occurs
description
data/trusted-key (trusted-key) 0/unbounded (no documentation provided)