Sonatype Nexus OSS REST 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 error-report-request

Example XML

<?xml version="1.0" encoding="UTF-8"?> <error-report-request> <data> <!--content of type 'error-report-request-dto'--> <description> <!--content of type 'string'--> ... </description> <errorReportingSettings> <!--content of type 'error-reporting-settings'--> <reportErrorsAutomatically> <!--content of type 'boolean'--> ... </reportErrorsAutomatically> <jiraPassword> <!--content of type 'string'--> ... </jiraPassword> <jiraUsername> <!--content of type 'string'--> ... </jiraUsername> <useGlobalProxy> <!--content of type 'boolean'--> ... </useGlobalProxy> </errorReportingSettings> <title> <!--content of type 'string'--> ... </title> <saveErrorReportingSettings> <!--content of type 'boolean'--> ... </saveErrorReportingSettings> </data> </error-report-request>

Example JSON

{ "data" : { "description" : "...", "errorReportingSettings" : { "reportErrorsAutomatically" : false, "jiraPassword" : "...", "jiraUsername" : "...", "useGlobalProxy" : false }, "title" : "...", "saveErrorReportingSettings" : false } }

Element global-settings

Example XML

<?xml version="1.0" encoding="UTF-8"?> <global-settings> <data> <!--content of type 'global-settings-item'--> <smtpSettings> <!--content of type 'smtp-settings'--> <sslEnabled> <!--content of type 'boolean'--> ... </sslEnabled> <username> <!--content of type 'string'--> ... </username> <systemEmailAddress> <!--content of type 'string'--> ... </systemEmailAddress> <host> <!--content of type 'string'--> ... </host> <port> <!--content of type 'int'--> ... </port> <password> <!--content of type 'string'--> ... </password> <tlsEnabled> <!--content of type 'boolean'--> ... </tlsEnabled> </smtpSettings> <globalRestApiSettings> <!--content of type 'rest-api-settings'--> <forceBaseUrl> <!--content of type 'boolean'--> ... </forceBaseUrl> <uiTimeout> <!--content of type 'int'--> ... </uiTimeout> <baseUrl> <!--content of type 'string'--> ... </baseUrl> </globalRestApiSettings> <securityAnonymousPassword> <!--content of type 'string'--> ... </securityAnonymousPassword> <securityRealms> <securityRealmItem> <!--content of type 'string'--> ... </securityRealmItem> <securityRealmItem> <!--(another 'string' type)--> </securityRealmItem> <!--...more "securityRealmItem" elements...--> </securityRealms> <securityAnonymousAccessEnabled> <!--content of type 'boolean'--> ... </securityAnonymousAccessEnabled> <errorReportingSettings> <!--content of type 'error-reporting-settings'--> <reportErrorsAutomatically> <!--content of type 'boolean'--> ... </reportErrorsAutomatically> <jiraPassword> <!--content of type 'string'--> ... </jiraPassword> <jiraUsername> <!--content of type 'string'--> ... </jiraUsername> <useGlobalProxy> <!--content of type 'boolean'--> ... </useGlobalProxy> </errorReportingSettings> <securityAnonymousUsername> <!--content of type 'string'--> ... </securityAnonymousUsername> <globalConnectionSettings> <!--content of type 'remote-connection-settings'--> <connectionTimeout> <!--content of type 'int'--> ... </connectionTimeout> <retrievalRetryCount> <!--content of type 'int'--> ... </retrievalRetryCount> <queryString> <!--content of type 'string'--> ... </queryString> <userAgentString> <!--content of type 'string'--> ... </userAgentString> </globalConnectionSettings> <securityEnabled> <!--content of type 'boolean'--> ... </securityEnabled> <globalHttpProxySettings> <!--content of type 'remote-http-proxy-settings'--> <nonProxyHosts> <!--content of type 'string'--> ... </nonProxyHosts> <nonProxyHosts> <!--(another 'string' type)--> </nonProxyHosts> <!--...more "nonProxyHosts" elements...--> <proxyHostname> <!--content of type 'string'--> ... </proxyHostname> <proxyPort> <!--content of type 'int'--> ... </proxyPort> <authentication> <!--content of type 'authentication-settings'--> <username> <!--content of type 'string'--> ... </username> <ntlmDomain> <!--content of type 'string'--> ... </ntlmDomain> <password> <!--content of type 'string'--> ... </password> <ntlmHost> <!--content of type 'string'--> ... </ntlmHost> </authentication> </globalHttpProxySettings> <systemNotificationSettings> <!--content of type 'system-notification-settings'--> <emailAddresses> <!--content of type 'string'--> ... </emailAddresses> <enabled> <!--content of type 'boolean'--> ... </enabled> <roles> <!--content of type 'string'--> ... </roles> <roles> <!--(another 'string' type)--> </roles> <!--...more "roles" elements...--> </systemNotificationSettings> </data> </global-settings>

Example JSON

{ "data" : { "smtpSettings" : { "sslEnabled" : false, "username" : "...", "systemEmailAddress" : "...", "host" : "...", "port" : ..., "password" : "...", "tlsEnabled" : false }, "globalRestApiSettings" : { "forceBaseUrl" : false, "uiTimeout" : ..., "baseUrl" : "..." }, "securityAnonymousPassword" : "...", "securityRealms" : [ "...", ... ], "securityAnonymousAccessEnabled" : false, "errorReportingSettings" : { "reportErrorsAutomatically" : false, "jiraPassword" : "...", "jiraUsername" : "...", "useGlobalProxy" : false }, "securityAnonymousUsername" : "...", "globalConnectionSettings" : { "connectionTimeout" : ..., "retrievalRetryCount" : ..., "queryString" : "...", "userAgentString" : "..." }, "securityEnabled" : false, "globalHttpProxySettings" : { "nonProxyHosts" : [ "...", ... ], "proxyHostname" : "...", "proxyPort" : ..., "authentication" : { "username" : "...", "ntlmDomain" : "...", "password" : "...", "ntlmHost" : "..." } }, "systemNotificationSettings" : { "emailAddresses" : "...", "enabled" : false, "roles" : [ "...", ... ] } } }

Element log-config

Example XML

<?xml version="1.0" encoding="UTF-8"?> <log-config> <data> <!--content of type 'log-config-resource'--> <rootLoggerLevel> <!--content of type 'string'--> ... </rootLoggerLevel> <rootLoggerAppenders> <!--content of type 'string'--> ... </rootLoggerAppenders> <fileAppenderLocation> <!--content of type 'string'--> ... </fileAppenderLocation> <fileAppenderPattern> <!--content of type 'string'--> ... </fileAppenderPattern> </data> </log-config>

Example JSON

{ "data" : { "rootLoggerLevel" : "...", "rootLoggerAppenders" : "...", "fileAppenderLocation" : "...", "fileAppenderPattern" : "..." } }

Element mirror-list-request

Example XML

<?xml version="1.0" encoding="UTF-8"?> <mirror-list-request> <data> <mirrorResource> <!--content of type 'mirror-resource'--> <url> <!--content of type 'string'--> ... </url> <id> <!--content of type 'string'--> ... </id> </mirrorResource> <mirrorResource> <!--(another 'mirror-resource' type)--> </mirrorResource> <!--...more "mirrorResource" elements...--> </data> </mirror-list-request>

Example JSON

{ "data" : [ { "url" : "...", "id" : "..." }, ... ] }

Element privilege-request

Example XML

<?xml version="1.0" encoding="UTF-8"?> <privilege-request> <data> <!--content of type 'privilege'--> <repositoryGroupId> <!--content of type 'string'--> ... </repositoryGroupId> <name> <!--content of type 'string'--> ... </name> <repositoryId> <!--content of type 'string'--> ... </repositoryId> <description> <!--content of type 'string'--> ... </description> <type> <!--content of type 'string'--> ... </type> <repositoryTargetId> <!--content of type 'string'--> ... </repositoryTargetId> <methods> <method> <!--content of type 'string'--> ... </method> <method> <!--(another 'string' type)--> </method> <!--...more "method" elements...--> </methods> </data> </privilege-request>

Example JSON

{ "data" : { "repositoryGroupId" : "...", "name" : "...", "repositoryId" : "...", "description" : "...", "type" : "...", "repositoryTargetId" : "...", "methods" : [ "...", ... ] } }

Element repo-group

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repo-group> <data> <!--content of type 'repository-group-resource'--> <repositories> <repo-group-member> <!--content of type 'repository-group-member-repository'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <name> <!--content of type 'string'--> ... </name> <id> <!--content of type 'string'--> ... </id> </repo-group-member> <repo-group-member> <!--(another 'repository-group-member-repository' type)--> </repo-group-member> <!--...more "repo-group-member" elements...--> </repositories> </data> </repo-group>

Example JSON

{ "data" : { "repositories" : [ { "resourceURI" : "...", "name" : "...", "id" : "..." }, ... ] } }

Element repo-route

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repo-route> <data> <!--content of type 'repository-route-resource'--> <groupId> <!--content of type 'string'--> ... </groupId> <id> <!--content of type 'string'--> ... </id> <ruleType> <!--content of type 'string'--> ... </ruleType> <pattern> <!--content of type 'string'--> ... </pattern> <repositories> <repository> <!--content of type 'repository-route-member-repo'--> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <resourceURI> <!--content of type 'string'--> ... </resourceURI> </repository> <repository> <!--(another 'repository-route-member-repo' type)--> </repository> <!--...more "repository" elements...--> </repositories> </data> </repo-route>

Example JSON

{ "data" : { "groupId" : "...", "id" : "...", "ruleType" : "...", "pattern" : "...", "repositories" : [ { "id" : "...", "name" : "...", "resourceURI" : "..." }, ... ] } }

Element repository

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repository> <data> <!--content of type 'base-repository'--> <repoType> <!--content of type 'string'--> ... </repoType> <providerRole> <!--content of type 'string'--> ... </providerRole> <provider> <!--content of type 'string'--> ... </provider> <exposed> <!--content of type 'boolean'--> ... </exposed> <name> <!--content of type 'string'--> ... </name> <id> <!--content of type 'string'--> ... </id> <contentResourceURI> <!--content of type 'string'--> ... </contentResourceURI> <format> <!--content of type 'string'--> ... </format> </data> </repository>

Example JSON

{ "data" : { "repoType" : "...", "providerRole" : "...", "provider" : "...", "exposed" : false, "name" : "...", "id" : "...", "contentResourceURI" : "...", "format" : "..." } }

Element repository-status

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repository-status> <data> <!--content of type 'repository-status'--> <remoteStatus> <!--content of type 'string'--> ... </remoteStatus> <localStatus> <!--content of type 'string'--> ... </localStatus> <id> <!--content of type 'string'--> ... </id> <proxyMode> <!--content of type 'string'--> ... </proxyMode> <format> <!--content of type 'string'--> ... </format> <dependentRepos> <dependentRepoItem> <!--content of type 'repository-dependent-status'--> <repoType> <!--content of type 'string'--> ... </repoType> <localStatus> <!--content of type 'string'--> ... </localStatus> <format> <!--content of type 'string'--> ... </format> <id> <!--content of type 'string'--> ... </id> </dependentRepoItem> <dependentRepoItem> <!--(another 'repository-dependent-status' type)--> </dependentRepoItem> <!--...more "dependentRepoItem" elements...--> </dependentRepos> <repoType> <!--content of type 'string'--> ... </repoType> </data> </repository-status>

Example JSON

{ "data" : { "remoteStatus" : "...", "localStatus" : "...", "id" : "...", "proxyMode" : "...", "format" : "...", "dependentRepos" : [ { "repoType" : "...", "localStatus" : "...", "format" : "...", "id" : "..." }, ... ], "repoType" : "..." } }

Element repo-target

Example XML

<?xml version="1.0" encoding="UTF-8"?> <repo-target> <data> <!--content of type 'repository-target-resource'--> <contentClass> <!--content of type 'string'--> ... </contentClass> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <patterns> <pattern> <!--content of type 'string'--> ... </pattern> <pattern> <!--(another 'string' type)--> </pattern> <!--...more "pattern" elements...--> </patterns> </data> </repo-target>

Example JSON

{ "data" : { "contentClass" : "...", "resourceURI" : "...", "id" : "...", "name" : "...", "patterns" : [ "...", ... ] } }

Element scheduled-task

Example XML

<?xml version="1.0" encoding="UTF-8"?> <scheduled-task> <data> <!--content of type 'scheduled-service-base-resource'--> <enabled> <!--content of type 'boolean'--> ... </enabled> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <properties> <scheduled-task-property> <!--content of type 'scheduled-service-property-resource'--> <key> <!--content of type 'string'--> ... </key> <value> <!--content of type 'string'--> ... </value> </scheduled-task-property> <scheduled-task-property> <!--(another 'scheduled-service-property-resource' type)--> </scheduled-task-property> <!--...more "scheduled-task-property" elements...--> </properties> <schedule> <!--content of type 'string'--> ... </schedule> <alertEmail> <!--content of type 'string'--> ... </alertEmail> <typeId> <!--content of type 'string'--> ... </typeId> </data> </scheduled-task>

Example JSON

{ "data" : { "enabled" : false, "id" : "...", "name" : "...", "properties" : [ { "key" : "...", "value" : "..." }, ... ], "schedule" : "...", "alertEmail" : "...", "typeId" : "..." } }

Element smtp-settings-request

Example XML

<?xml version="1.0" encoding="UTF-8"?> <smtp-settings-request> <data> <!--content of type 'smtp-settings-resource'--> <host> <!--content of type 'string'--> ... </host> <tlsEnabled> <!--content of type 'boolean'--> ... </tlsEnabled> <sslEnabled> <!--content of type 'boolean'--> ... </sslEnabled> <username> <!--content of type 'string'--> ... </username> <port> <!--content of type 'int'--> ... </port> <testEmail> <!--content of type 'string'--> ... </testEmail> <password> <!--content of type 'string'--> ... </password> <systemEmailAddress> <!--content of type 'string'--> ... </systemEmailAddress> </data> </smtp-settings-request>

Example JSON

{ "data" : { "host" : "...", "tlsEnabled" : false, "sslEnabled" : false, "username" : "...", "port" : ..., "testEmail" : "...", "password" : "...", "systemEmailAddress" : "..." } }

Type authentication-settings

Child Elements

name (type) min/max
occurs
description
username (string) 0/1 (no documentation provided)
ntlmDomain (string) 0/1 (no documentation provided)
password (string) 0/1 (no documentation provided)
ntlmHost (string) 0/1 (no documentation provided)

Type base-repository

Child Elements

name (type) min/max
occurs
description
repoType (string) 0/1 (no documentation provided)
providerRole (string) 0/1 (no documentation provided)
provider (string) 0/1 (no documentation provided)
exposed (boolean) 1/1 (no documentation provided)
name (string) 0/1 (no documentation provided)
id (string) 0/1 (no documentation provided)
contentResourceURI (string) 0/1 (no documentation provided)
format (string) 0/1 (no documentation provided)

Type error-reporting-settings

Child Elements

name (type) min/max
occurs
description
reportErrorsAutomatically (boolean) 1/1 (no documentation provided)
jiraPassword (string) 0/1 (no documentation provided)
jiraUsername (string) 0/1 (no documentation provided)
useGlobalProxy (boolean) 1/1 (no documentation provided)

Type errorReportRequest

Child Elements

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

Type error-report-request-dto

Child Elements

name (type) min/max
occurs
description
description (string) 0/1 (no documentation provided)
errorReportingSettings (error-reporting-settings) 0/1 (no documentation provided)
title (string) 0/1 (no documentation provided)
saveErrorReportingSettings (boolean) 1/1 (no documentation provided)

Type globalConfigurationResourceResponse

Child Elements

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

Type global-settings-item

Child Elements

name (type) min/max
occurs
description
smtpSettings (smtp-settings) 0/1 (no documentation provided)
globalRestApiSettings (rest-api-settings) 0/1 (no documentation provided)
securityAnonymousPassword (string) 0/1 (no documentation provided)
securityRealmItem (string) 0/unbounded (no documentation provided)
securityAnonymousAccessEnabled (boolean) 1/1 (no documentation provided)
errorReportingSettings (error-reporting-settings) 0/1 (no documentation provided)
securityAnonymousUsername (string) 0/1 (no documentation provided)
globalConnectionSettings (remote-connection-settings) 0/1 (no documentation provided)
securityEnabled (boolean) 1/1 (no documentation provided)
globalHttpProxySettings (remote-http-proxy-settings) 0/1 (no documentation provided)
systemNotificationSettings (system-notification-settings) 0/1 (no documentation provided)

Type log-config-resource

Child Elements

name (type) min/max
occurs
description
rootLoggerLevel (string) 0/1 (no documentation provided)
rootLoggerAppenders (string) 0/1 (no documentation provided)
fileAppenderLocation (string) 0/1 (no documentation provided)
fileAppenderPattern (string) 0/1 (no documentation provided)

Type logConfigResourceResponse

Child Elements

name (type) min/max
occurs
description
data (log-config-resource) 0/1 (no documentation provided)

Type mirror-resource

Child Elements

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

Type mirrorResourceListRequest

Child Elements

name (type) min/max
occurs
description
mirrorResource (mirror-resource) 0/unbounded (no documentation provided)

Type privilege

Child Elements

name (type) min/max
occurs
description
repositoryGroupId (string) 0/1 (no documentation provided)
name (string) 0/1 (no documentation provided)
repositoryId (string) 0/1 (no documentation provided)
description (string) 0/1 (no documentation provided)
type (string) 0/1 (no documentation provided)
repositoryTargetId (string) 0/1 (no documentation provided)
method (string) 0/unbounded (no documentation provided)

Type privilegeResourceRequest

Child Elements

name (type) min/max
occurs
description
data (privilege) 0/1 (no documentation provided)

Type remote-connection-settings

Child Elements

name (type) min/max
occurs
description
connectionTimeout (int) 1/1 (no documentation provided)
retrievalRetryCount (int) 1/1 (no documentation provided)
queryString (string) 0/1 (no documentation provided)
userAgentString (string) 0/1 (no documentation provided)

Type remote-http-proxy-settings

Child Elements

name (type) min/max
occurs
description
nonProxyHosts (string) 0/unbounded (no documentation provided)
proxyHostname (string) 0/1 (no documentation provided)
proxyPort (int) 1/1 (no documentation provided)
authentication (authentication-settings) 0/1 (no documentation provided)

Type repository-dependent-status

Child Elements

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

Type repository-group-member-repository

Child Elements

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

Type repository-group-resource

Child Elements

name (type) min/max
occurs
description
repo-group-member (repository-group-member-repository) 0/unbounded (no documentation provided)

Type repositoryGroupResourceResponse

Child Elements

name (type) min/max
occurs
description
data (repository-group-resource) 0/1 (no documentation provided)

Type repositoryResourceResponse

Child Elements

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

Type repository-route-member-repo

Child Elements

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

Type repository-route-resource

Child Elements

name (type) min/max
occurs
description
groupId (string) 0/1 (no documentation provided)
id (string) 0/1 (no documentation provided)
ruleType (string) 0/1 (no documentation provided)
pattern (string) 0/1 (no documentation provided)
repository (repository-route-member-repo) 0/unbounded (no documentation provided)

Type repositoryRouteResourceResponse

Child Elements

name (type) min/max
occurs
description
data (repository-route-resource) 0/1 (no documentation provided)

Type repository-status

Child Elements

name (type) min/max
occurs
description
remoteStatus (string) 0/1 (no documentation provided)
localStatus (string) 0/1 (no documentation provided)
id (string) 0/1 (no documentation provided)
proxyMode (string) 0/1 (no documentation provided)
format (string) 0/1 (no documentation provided)
dependentRepoItem (repository-dependent-status) 0/unbounded (no documentation provided)
repoType (string) 0/1 (no documentation provided)

Type repositoryStatusResourceResponse

Child Elements

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

Type repository-target-resource

Child Elements

name (type) min/max
occurs
description
contentClass (string) 0/1 (no documentation provided)
resourceURI (string) 0/1 (no documentation provided)
id (string) 0/1 (no documentation provided)
name (string) 0/1 (no documentation provided)
pattern (string) 0/unbounded (no documentation provided)

Type repositoryTargetResourceResponse

Child Elements

name (type) min/max
occurs
description
data (repository-target-resource) 0/1 (no documentation provided)

Type rest-api-settings

Child Elements

name (type) min/max
occurs
description
forceBaseUrl (boolean) 1/1 (no documentation provided)
uiTimeout (int) 1/1 (no documentation provided)
baseUrl (string) 0/1 (no documentation provided)

Type scheduled-service-base-resource

Child Elements

name (type) min/max
occurs
description
enabled (boolean) 1/1 (no documentation provided)
id (string) 0/1 (no documentation provided)
name (string) 0/1 (no documentation provided)
scheduled-task-property (scheduled-service-property-resource) 0/unbounded (no documentation provided)
schedule (string) 0/1 (no documentation provided)
alertEmail (string) 0/1 (no documentation provided)
typeId (string) 0/1 (no documentation provided)

Type scheduled-service-property-resource

Child Elements

name (type) min/max
occurs
description
key (string) 0/1 (no documentation provided)
value (string) 0/1 (no documentation provided)

Type scheduledServiceResourceResponse

Child Elements

name (type) min/max
occurs
description
data (scheduled-service-base-resource) 0/1 (no documentation provided)

Type smtp-settings

Child Elements

name (type) min/max
occurs
description
sslEnabled (boolean) 1/1 (no documentation provided)
username (string) 0/1 (no documentation provided)
systemEmailAddress (string) 0/1 (no documentation provided)
host (string) 0/1 (no documentation provided)
port (int) 1/1 (no documentation provided)
password (string) 0/1 (no documentation provided)
tlsEnabled (boolean) 1/1 (no documentation provided)

Type smtp-settings-resource

Child Elements

name (type) min/max
occurs
description
host (string) 0/1 (no documentation provided)
tlsEnabled (boolean) 1/1 (no documentation provided)
sslEnabled (boolean) 1/1 (no documentation provided)
username (string) 0/1 (no documentation provided)
port (int) 1/1 (no documentation provided)
testEmail (string) 0/1 (no documentation provided)
password (string) 0/1 (no documentation provided)
systemEmailAddress (string) 0/1 (no documentation provided)

Type smtpSettingsResourceRequest

Child Elements

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

Type system-notification-settings

Child Elements

name (type) min/max
occurs
description
emailAddresses (string) 0/1 (no documentation provided)
enabled (boolean) 1/1 (no documentation provided)
roles (string) 0/unbounded (no documentation provided)

Home

REST Endpoints

XML Data Elements

XML Data Types