GET /query?type=Credentials

Returns a resource representation of the credentials collection created on backup servers connected to Veeam Backup Enterprise Manager. For details, see /backupServers/{ID}/credentials.

Request

To get a list of credentials, send the GET HTTP request to the query with the type parameter set to Credentials.

HTTP Request

GET https://<Enterprise-Manager>:9398/api/query?type=Credentials

Request Headers

The request contains the following headers:

Header

Required

Description

X-RestSvcSessionId

True

The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security.

Accept

False

Identifies the format of the response. Possible values:

  • application/xml — the client can send this value in the header to accept response in the XML format.
  • application/json — the client must send this value in the header to accept the request in the JSON format.

If the request does not contain the header, the server will return the response in the XML format.

Request Body

None.

Optional Parameters

In the query, you can use the following parameters for filtering and sorting.

Parameter

Type

Description

Username

String

User name of the credentials record, for example: BACKUPSERVER\Administrator.

Description

String

Description of the credentials record, for example: Administrator credentials.

BackupServerUid

UidType

UID of the backup server on which the credentials record has been created, for example: urn:veeam:BackupServer:15942270-fb56-4dcc-96e9-5f80e4725a15.

CredentialsId

String

ID of the credentials record, for example:3ff61155-ed3d-47c5-a07b-29c7ca0d36b9.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message. Possible values:

  • application/xml
  • application/json

Response Body

In the response body, the REST API returns a representation of the /backupServers/{ID}/credentials resource collection.

Example

The example below returns an entity resource representation of a collection of credentials that have the administrator user name.

Request:

GET https://localhost:9398/api/query?type=Credentials&format=Entities&filter=Username==administrator

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 OK

 

Response Body:

<QueryResult xmlns="http://www.veeam.com/ent/v1.0">
 <Resources>
   <CredentialsList>
     <CredentialsInfo Type="Credentials" Href="https://localhost:9398/api/backupServers/beda8585-1354-451c-afe2-646dcf42afa6/credentials/2b20d9a3-4de9-4426-aa6a-1d8c00abd114">
       <Links>
         <Link Rel="Up" Type="BackupServer" Href="https://localhost:9398/api/backupServers/beda8585-1354-451c-afe2-646dcf42afa6?format=Entity" Name="backupsrv29.tech.local" />
         <Link Rel="Edit" Type="Credentials" Href="https://localhost:9398/api/backupServers/beda8585-1354-451c-afe2-646dcf42afa6/credentials/2b20d9a3-4de9-4426-aa6a-1d8c00abd114" />
         <Link Rel="Delete" Type="Credentials" Href="https://localhost:9398/api/backupServers/beda8585-1354-451c-afe2-646dcf42afa6/credentials/2b20d9a3-4de9-4426-aa6a-1d8c00abd114" />
       </Links>
       <Id>2b20d9a3-4de9-4426-aa6a-1d8c00abd114</Id>
       <Username>administrator</Username>
       <Description>administrator</Description>
       <Password />
     </CredentialsInfo>
   </CredentialsList>
 </Resources>
 <PagingInfo PagesCount="1" PageSize="100" PageNum="1">
   <Links>
     <Link Rel="First" Href="https://localhost:9398/api/query?type=Credentials&format=Entities&sortAsc=BackupServerUid&filter=Username==administrator&pageSize=100&page=1" />
     <Link Rel="Last" Href="https://localhost:9398/api/query?type=Credentials&format=Entities&sortAsc=BackupServerUid&filter=Username==administrator&pageSize=100&page=1" />
   </Links>
 </PagingInfo>
</QueryResult>