topic How does the API work in a multi domain environment? in API / CLI Discussion

How does the API work in a multi domain environment?

Uri_Bialik — Wed, 23 Dec 2015 09:06:02 GMT

In a multi-domain environment there is one API server.

Turning this server on/off is done on the MDS level.

When you login using mgmt_cli always provide the IP address of the MDS server and provide the domain name.

For example:

mgmt_cli login user <my name> password <my password> domain <my domain name> -m <IP address or DNS name of the MDS>
mgmt_cli add-host name <host name> ip-address <ip-address of the new host> -u <username> -p <password> -d <domain name> -m <IP address or DNS name of the MDS>

When using the login API without providing the domain name, you will be logged in to the MDS.

Similarly when making a web-service requests:

* The URL of the request should point to the MDS

* In the login API, provide the domain name as an argument.

For example:

POST

https://MDS_server_ip/web_api/login

Headers:

Content-Type: application/json

Payload:

{

"user" : "myuser",

"password" : "mypassword",

"domain" : "my domain name"

}

Re: How does the API work in a multi domain environment?

Joshua_Boerum — Fri, 01 Jul 2016 14:31:27 GMT

Glad I found this post. I was trying to figure out why I wasn't seeing objects I would create VIA the API wouldn't show up in the GUI. Specifying the domain fixed that.

Where was I creating objects when I wasn't specifying the domain?

Re: How does the API work in a multi domain environment?

Ash_Sidhu — Fri, 22 Feb 2019 15:41:05 GMT

Thanks for posting this. This is not explained even in the official documentation .

Saved a lot of time .