POST /vCloud/orgConfigs/{ID}?action=disable

Disables the default VMware Cloud Director organization configuration with the specified ID.

The default organization configuration always appears in the list of configurations under the name Other organizations. When you disable the default configuration, VMware Cloud Director organizations for which individual configurations were not created can no longer perform self-service backup.

Note

You cannot disable a custom configuration that was created for a specific VMware Cloud Director organization. Instead, you can delete such configuration. For details, see DELETE /vCloud/orgConfigs/{ID}.

Request

To disable self-service backup for VMware Cloud Director organizations that do not have individual configurations, send the POST HTTP request to the /vCloud/orgConfigs/{ID}?action=disable URL.

HTTP Request

POST https://<Enterprise-Manager>:9398/api/vCloud/orgConfigs/{ID}?action=disable

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.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 202 Accepted.

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 task that has been created to perform the requested operation. To track the status of the operation, send the GET /tasks/{ID} request.

The task resource also contains a link to the task deletion operation. To stop the task execution, send the DELETE /task/{ID} request to the URL in the link.

Example

The example below disables self-service backup for VMware Cloud Director organizations that do not have individual configuration. sa VMware Cloud Director organization configuration with ID bcd350cd-a453-4124-b099-4d071431154b.

Request:

POST https://localhost:9398/api/vCloud/orgConfigs/bcd350cd-a453-4124-b099-4d071431154b?action=disable

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

202 Accepted

 

Response Body:

<Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1">
 <Links>
   <Link Rel="Delete" Type="Task" Href="https://localhost:9398/api/tasks/task-1" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Running</State>
 <Operation>EditOtherOrganizationConfig</Operation>
</Task>

To track the status of the operation, send the GET HTTP request to the URL of the received task resource:

Request:

GET https://localhost:9398/api/tasks/task-1

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 OK

 

Response Body:

<Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1">
 <Links>
   <Link Rel="Delete" Type="Task" Href="https://localhost:9398/api/tasks/task-1" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Finished</State>
 <Operation>EditOtherOrganizationConfig</Operation>
 <Result Success="true">
   <Message>Ok</Message>
 </Result>
</Task>