Pod onboard request

Description

This API onboards pods

API stability classification

API overview

HTTP method	URI	Return type	Return type multiplicity
POST	csm/Pod/onboard	void	Not applicable

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objectsThe [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

Name	Type	Multi- plicity	Description
callbackURL	String	0..1	URL to call when the operation finishes
postCallout	String	0..1	Identifier of a callout to run after the operation executes
preCallout	String	0..1	Identifier of a callout to run before the operation executes
timeout	Integer	0..1	Timeout setting. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values: 0: Immediate timeout -1: Uses the system default timeout value 1..*: Times out in the specified number of seconds
operationParams	OperationParameter	1	Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing-input-parameters-with-an-API-request.

The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.
Input parameters to include in operationParamsThe [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

Name	Type	Multi- plicity	Description
pods	Pod	1..*	List of pods to onboard
providerURI	String	1	Provider URI

HTTP response message

Response message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Response message body

The response message body contains a Task object.

Example

The following example shows an HTTP request that onboards a pod:

POST /csm/pod/search HTTP/1.1
Host: <apiServer>
Authentication-Token: <yourToken>

{
    "timeout" : -1,
    "preCallout" : "",
    "postCallout" : "",
    "operationParams" : [ {
        "name" : "pods",
        "value" : [ {
            "cloudClass" : "com.bmc.cloud.model.beans.Pod",
            "externalID" : "8bf6a03d-ec7e-4014-ab46-420ff7dd4748:MY-POD-NAME"
        } ],
        "type" : "com.bmc.cloud.model.beans.Pod",
        "multiplicity" : "1..*"
    }, {
        "name" : "providerURI",
        "value" : "/provider/8bf6a03d-ec7e-4014-ab46-420ff7dd4748",
        "type" : "java.lang.String",
        "multiplicity" : "1"
    } ]
}

The [expand] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.