HostnameAdvice create request (Provider API)

Description

This API creates a HostnameAdvice object.

API stability classification

API overview

HTTP method	URI	Return type	Return type multiplicity
POST	csm/HostnameAdvice/create	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
computeContainerSpec	ComputeContainerSpec	0..1	Compute container specification
computeSpec	ComputeSpec	1
deploymentParameterValue	DeploymentParameterValue	0..*	Deployment parameter values
fcSpecList	FunctionalComponentSpec	1..*
functionalComponentSpec	FunctionalComponentSpec	0..*	List of functional component specifications
hostnamePrefix	String	0..1	Host name prefix
location	Location	0..1	Location
logicalHostingEnvironment	LogicalHostingEnvironment	1	Logical hosting environment
organization	Organization	1	Tenant organization
resourceSetSpec	ResourceSetSpec	0..1	Resource set specification
rsSpec	ResourceSetSpec	1
serviceOfferingInstanceName	String	1	Name of the service offering instance
userParameters	DeploymentParameterValue	0..*	List of user parameters

HostnameAdvice create request (Provider API)

Description

API stability classification

API overview

HTTP request message

Query string parameters

Request message headers

Request message body

HTTP response message

Response message headers

Response message body

On this page