Specify a domain to work on

Use this API to specify a domain to work on to get or set NetBrain data by associating domainID to the current session.

Resource Information

Method

URL

Required authentication

PUT

/V1/Session/CurrentDomain

Yes

Parameters

Name

Description

Token*required
(header)

Input the token received from the API Log in to get an authentication token.

Request*required
(body)

The body contains two parameters:

▪tenantId*(string): input the ID of the target tenant. Get a tenant ID by using the API Get all accessible tenant.

▪domainId*(string): input the ID of the target domain. Get a domain ID by using the API Get all accessible domains of a tenant.

Example:

{
  "tenantId": "3e75247a-309c-4231-96a5-823b6cb1e78d",
  "domainId": "4e75247a-309c-4231-96a5-823b6cb1e78d"
}

Response

Parameter

Type

Description

Example

statusCode

integer

The returned status code of executing the API.

{
  "statusCode": 790200,
  "statusDescription": "success"
}

statusDescription

string

The explanation of the status code.