Provision Application Type

Provisions or registers a Service Fabric application type with the cluster using the '.sfpkg' package in the external store or using the application package in the image store.

Provisions a Service Fabric application type with the cluster. The provision is required before any new applications can be instantiated. The provision operation can be performed either on the application package specified by the relativePathInImageStore, or by using the URI of the external '.sfpkg'.


Method Request URI
POST /ApplicationTypes/$/Provision?api-version=6.2&timeout={timeout}


Name Type Required Location
api-version string Yes Query
timeout integer (int64) No Query
ProvisionApplicationTypeDescriptionBaseRequiredBodyParam ProvisionApplicationTypeDescriptionBase Yes Body


Type: string
Required: Yes
Default: 6.2

The version of the API. This parameter is required and its value must be '6.2'.

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 version 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 accepts 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 and the runtime is 6.1, 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.


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.


Type: ProvisionApplicationTypeDescriptionBase
Required: Yes

The base type of provision application type description which supports either image store-based provision or external store-based provision.


HTTP Status Code Description Response Schema
200 (OK) A successful provision will return 200 status code.
202 (Accepted) A 202 status code indicates the operation was accepted and the provision operation has been initiated.
All other status codes The detailed error response.