Create Application
Creates a Service Fabric application.
Creates a Service Fabric application using the specified description.
Request
| Method | Request URI |
|---|---|
| POST | /Applications/$/Create?api-version=6.0&timeout={timeout} |
Parameters
| Name | Type | Required | Location |
|---|---|---|---|
api-version |
string | Yes | Query |
timeout |
integer (int64) | No | Query |
ApplicationDescription |
ApplicationDescription | Yes | Body |
api-version
Type: string
Required: Yes
Default: 6.0
The version of the API. This parameter is required and its value must be '6.0'.
Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.
Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.
timeout
Type: integer (int64)
Required: No
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
ApplicationDescription
Type: ApplicationDescription
Required: Yes
Description for creating an application.
Responses
| HTTP Status Code | Description | Response Schema |
|---|---|---|
| 201 (Created) | A successful response means that the application creation has been started. Use GetApplication operation to get the status of the application. Once GetApplicationInfo successfully returns application information, the application is created. If the application has default services those may be in the process of being created. Use GetServiceInfo operation to get the status of the service within the application. |
|
| All other status codes | The detailed error response. |
FabricError |
Examples
Create application.
This example shows how to create a Service Fabric application without overriding any application parameter values.
Request
POST http://localhost:19080/Applications/$/Create?api-version=6.0
Body
{
"Name": "fabric:/samples/CalcApp",
"TypeVersion": "1.0",
"TypeName": "CalculatorApp"
}
201 Response
Body
The response body is empty.