Azure Servicefabric
Service Fabric REST Client APIs allows management of Service Fabric clusters, applications and services.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Service Fabric REST Client APIs allows management of Service Fabric clusters, applications and services.
Endpoints 247
Cluster
- GETGet the Service Fabric cluster manifest.
/$/GetClusterManifest?api-version=6.0&timeout=60Get the Service Fabric cluster manifest. The cluster manifest contains properties of the cluster that include different node types on the cluster, security… - GETGets the health of a Service Fabric cluster.
/$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter=0&ApplicationsHealthStateFilter=0&EventsHealthStateFilter=0&ExcludeHealthStatistics=false&IncludeSystemApplicationHealthStatistics=false&timeout=60Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Similarly, use NodesHealthStateFilter… - POSTGets the health of a Service Fabric cluster using the specified policy.
/$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter=0&ApplicationsHealthStateFilter=0&EventsHealthStateFilter=0&ExcludeHealthStatistics=false&IncludeSystemApplicationHealthStatistics=false&timeout=60Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Similarly, use NodesHealthStateFilter… - GETGets the health of a Service Fabric cluster using health chunks.
/$/GetClusterHealthChunk?api-version=6.0&timeout=60Gets the health of a Service Fabric cluster using health chunks. Includes the aggregated health state of the cluster, but none of the cluster entities. To… - POSTGets the health of a Service Fabric cluster using health chunks.
/$/GetClusterHealthChunk?api-version=6.0&timeout=60Gets the health of a Service Fabric cluster using health chunks. The health evaluation is done based on the input cluster health chunk query description. The… - POSTSends a health report on the Service Fabric cluster.
/$/ReportClusterHealth?api-version=6.0&Immediate=false&timeout=60Sends a health report on a Service Fabric cluster. The report must contain the information about the source of the health report and property on which it is… - GETGets a list of fabric code versions that are provisioned in a Service Fabric cluster.
/$/GetProvisionedCodeVersions?api-version=6.0&CodeVersion=string&timeout=60Gets a list of information about fabric code versions that are provisioned in the cluster. The parameter CodeVersion can be used to optionally filter the… - GETGets a list of fabric config versions that are provisioned in a Service Fabric cluster.
/$/GetProvisionedConfigVersions?api-version=6.0&ConfigVersion=string&timeout=60Gets a list of information about fabric config versions that are provisioned in the cluster. The parameter ConfigVersion can be used to optionally filter the… - GETGets the progress of the current cluster upgrade.
/$/GetUpgradeProgress?api-version=6.0&timeout=60Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, get the last state of the previous cluster upgrade. - GETGet the Service Fabric standalone cluster configuration.
/$/GetClusterConfiguration?api-version=6.0&ConfigurationApiVersion=string&timeout=60The cluster configuration contains properties of the cluster that include different node types on the cluster, security configurations, fault, and upgrade… - GETGet the cluster configuration upgrade status of a Service Fabric standalone cluster.
/$/GetClusterConfigurationUpgradeStatus?api-version=6.0&timeout=60Get the cluster configuration upgrade status details of a Service Fabric standalone cluster. - GETGet the service state of Service Fabric Upgrade Orchestration Service.
/$/GetUpgradeOrchestrationServiceState?api-version=6.0&timeout=60Get the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes. - POSTUpdate the service state of Service Fabric Upgrade Orchestration Service.
/$/SetUpgradeOrchestrationServiceState?api-version=6.0&timeout=60Update the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes. - POSTProvision the code or configuration packages of a Service Fabric cluster.
/$/Provision?api-version=6.0&timeout=60Validate and provision the code or configuration packages of a Service Fabric cluster. - POSTUnprovision the code or configuration packages of a Service Fabric cluster.
/$/Unprovision?api-version=6.0&timeout=60It is supported to unprovision code and configuration separately. - POSTRoll back the upgrade of a Service Fabric cluster.
/$/RollbackUpgrade?api-version=6.0&timeout=60Roll back the code or configuration upgrade of a Service Fabric cluster. - POSTMake the cluster upgrade move on to the next upgrade domain.
/$/MoveToNextUpgradeDomain?api-version=6.0&timeout=60Make the cluster code or configuration upgrade move on to the next upgrade domain if appropriate. - POSTStart upgrading the code or configuration version of a Service Fabric cluster.
/$/Upgrade?api-version=6.0&timeout=60Validate the supplied upgrade parameters and start upgrading the code or configuration version of a Service Fabric cluster if the parameters are valid. - POSTStart upgrading the configuration of a Service Fabric standalone cluster.
/$/StartClusterConfigurationUpgrade?api-version=6.0&timeout=60Validate the supplied configuration upgrade parameters and start upgrading the cluster configuration if the parameters are valid. - POSTUpdate the upgrade parameters of a Service Fabric cluster upgrade.
/$/UpdateUpgrade?api-version=6.0&timeout=60Update the upgrade parameters used during a Service Fabric cluster upgrade. - GETGets the Azure Active Directory metadata used for secured connection to cluster.
/$/GetAadMetadata?api-version=6.0&timeout=60Gets the Azure Active Directory metadata used for secured connection to cluster. This API is not supposed to be called separately. It provides information… - GETGet the current Service Fabric cluster version.
/$/GetClusterVersion?api-version=6.4&timeout=60If a cluster upgrade is happening, then this API will return the lowest (older) version of the current and target cluster runtime versions. - GETGets the load of a Service Fabric cluster.
/$/GetLoadInformation?api-version=6.0&timeout=60Retrieves the load information of a Service Fabric cluster for all the metrics that have load or capacity defined. - POSTChanges the verbosity of service placement health reporting.
/$/ToggleVerboseServicePlacementHealthReporting?api-version=6.4&Enabled=true&timeout=60If verbosity is set to true, then detailed health reports will be generated when replicas cannot be placed or dropped. If verbosity is set to false, then no… - POSTValidate and assess the impact of a code or configuration version update of a Service Fabric cluster.
/$/ValidateUpgrade?api-version=8.2&timeout=60Validate the supplied upgrade parameters and assess the expected impact of a code or configuration version upgrade of a Service Fabric cluster. The upgrade…
Node
- GETGets the list of nodes in the Service Fabric cluster.
/Nodes?api-version=6.3&ContinuationToken=string&NodeStatusFilter=default&MaxResults=0&timeout=60The response includes the name, status, ID, health, uptime, and other details about the nodes. - GETGets the information about a specific node in the Service Fabric cluster.
/Nodes/:nodeName?api-version=6.0&timeout=60The response includes the name, status, ID, health, uptime, and other details about the node. - GETGets the health of a Service Fabric node.
/Nodes/:nodeName/$/GetHealth?api-version=6.0&EventsHealthStateFilter=0&timeout=60Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health… - POSTGets the health of a Service Fabric node, by using the specified health policy.
/Nodes/:nodeName/$/GetHealth?api-version=6.0&EventsHealthStateFilter=0&timeout=60Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health… - POSTSends a health report on the Service Fabric node.
/Nodes/:nodeName/$/ReportHealth?api-version=6.0&Immediate=false&timeout=60Reports health state of the specified Service Fabric node. The report must contain the information about the source of the health report and property on which… - GETGets the load information of a Service Fabric node.
/Nodes/:nodeName/$/GetLoadInformation?api-version=6.0&timeout=60Retrieves the load information of a Service Fabric node for all the metrics that have load or capacity defined. - POSTDeactivate a Service Fabric cluster node with the specified deactivation intent.
/Nodes/:nodeName/$/Deactivate?api-version=6.0&timeout=60Deactivate a Service Fabric cluster node with the specified deactivation intent. Once the deactivation is in progress, the deactivation intent can be… - POSTActivate a Service Fabric cluster node that is currently deactivated.
/Nodes/:nodeName/$/Activate?api-version=6.0&timeout=60Activates a Service Fabric cluster node that is currently deactivated. Once activated, the node will again become a viable target for placing new replicas,… - POSTNotifies Service Fabric that the persisted state on a node has been permanently removed or lost.
/Nodes/:nodeName/$/RemoveNodeState?api-version=6.0&timeout=60This implies that it is not possible to recover the persisted state of that node. This generally happens if a hard disk has been wiped clean, or if a hard… - POSTRestarts a Service Fabric cluster node.
/Nodes/:nodeName/$/Restart?api-version=6.0&timeout=60Restarts a Service Fabric cluster node that is already started. - DELETERemoves configuration overrides on the specified node.
/Nodes/:nodeName/$/RemoveConfigurationOverrides?api-version=7.0&timeout=60This api allows removing all existing configuration overrides on specified node. - GETGets the list of configuration overrides on the specified node.
/Nodes/:nodeName/$/GetConfigurationOverrides?api-version=7.0&timeout=60This api allows getting all existing configuration overrides on the specified node. - POSTAdds the list of configuration overrides on the specified node.
/Nodes/:nodeName/$/AddConfigurationParameterOverrides?api-version=7.0&Force=true&timeout=60This api allows adding all existing configuration overrides on the specified node. - POSTRemoves the list of tags from the specified node.
/Nodes/:nodeName/$/RemoveNodeTags?api-version=7.0This api allows removing set of tags from the specified node. - POSTAdds the list of tags on the specified node.
/Nodes/:nodeName/$/AddNodeTags?api-version=7.2This api allows adding tags to the specified node.
ApplicationType
- GETGets the list of application types in the Service Fabric cluster.
/ApplicationTypes?api-version=6.0&ApplicationTypeDefinitionKindFilter=0&ExcludeApplicationParameters=false&ContinuationToken=string&MaxResults=0&timeout=60Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. Each version of… - GETGets the list of application types in the Service Fabric cluster matching exactly the specified name.
/ApplicationTypes/:applicationTypeName?api-version=6.0&ApplicationTypeVersion=string&ExcludeApplicationParameters=false&ContinuationToken=string&MaxResults=0&timeout=60Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. These results… - POSTProvisions 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.
/ApplicationTypes/$/Provision?api-version=6.2&timeout=60Provisions a Service Fabric application type with the cluster. The provision is required before any new applications can be instantiated. The provision… - POSTRemoves or unregisters a Service Fabric application type from the cluster.
/ApplicationTypes/:applicationTypeName/$/Unprovision?api-version=6.0&timeout=60This operation can only be performed if all application instances of the application type have been deleted. Once the application type is unregistered, no new… - GETGets the manifest describing an application type.
/ApplicationTypes/:applicationTypeName/$/GetApplicationManifest?api-version=6.0&ApplicationTypeVersion=string&timeout=60The response contains the application manifest XML as a string.
ServiceType
- GETGets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster.
/ApplicationTypes/:applicationTypeName/$/GetServiceTypes?api-version=6.0&ApplicationTypeVersion=string&timeout=60Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. The provided… - GETGets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster.
/ApplicationTypes/:applicationTypeName/$/GetServiceTypes/:serviceTypeName?api-version=6.0&ApplicationTypeVersion=string&timeout=60Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. The provided application… - GETGets the manifest describing a service type.
/ApplicationTypes/:applicationTypeName/$/GetServiceManifest?api-version=6.0&ApplicationTypeVersion=string&ServiceManifestName=string&timeout=60Gets the manifest describing a service type. The response contains the service manifest XML as a string. - GETGets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster.
/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetServiceTypes?api-version=6.0&ServiceManifestName=string&timeout=60Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. The response includes the… - GETGets the information about a specified service type of the application deployed on a node in a Service Fabric cluster.
/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetServiceTypes/:serviceTypeName?api-version=6.0&ServiceManifestName=string&timeout=60Gets the list containing the information about a specific service type from the applications deployed on a node in a Service Fabric cluster. The response…
Application
- POSTCreates a Service Fabric application.
/Applications/$/Create?api-version=6.0&timeout=60Creates a Service Fabric application using the specified description. - POSTDeletes an existing Service Fabric application.
/Applications/:applicationId/$/Delete?api-version=6.0&ForceRemove=true&timeout=60An application must be created before it can be deleted. Deleting an application will delete all services that are part of that application. By default,… - GETGets load information about a Service Fabric application.
/Applications/:applicationId/$/GetLoadInformation?api-version=6.0&timeout=60Returns the load information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches… - GETGets the list of applications created in the Service Fabric cluster that match the specified filters.
/Applications?api-version=6.1&ApplicationDefinitionKindFilter=0&ApplicationTypeName=string&ExcludeApplicationParameters=false&ContinuationToken=string&MaxResults=0&timeout=60Gets the information about the applications that were created or in the process of being created in the Service Fabric cluster and match the specified… - GETGets information about a Service Fabric application.
/Applications/:applicationId?api-version=6.0&ExcludeApplicationParameters=false&timeout=60Returns the information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one… - GETGets the health of the service fabric application.
/Applications/:applicationId/$/GetHealth?api-version=6.0&EventsHealthStateFilter=0&DeployedApplicationsHealthStateFilter=0&ServicesHealthStateFilter=0&ExcludeHealthStatistics=false&timeout=60Returns the heath state of the service fabric application. The response reports either Ok, Error or Warning health state. If the entity is not found in the… - POSTGets the health of a Service Fabric application using the specified policy.
/Applications/:applicationId/$/GetHealth?api-version=6.0&EventsHealthStateFilter=0&DeployedApplicationsHealthStateFilter=0&ServicesHealthStateFilter=0&ExcludeHealthStatistics=false&timeout=60Gets the health of a Service Fabric application. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the… - POSTSends a health report on the Service Fabric application.
/Applications/:applicationId/$/ReportHealth?api-version=6.0&Immediate=false&timeout=60Reports health state of the specified Service Fabric application. The report must contain the information about the source of the health report and property… - POSTStarts upgrading an application in the Service Fabric cluster.
/Applications/:applicationId/$/Upgrade?api-version=6.0&timeout=60Validates the supplied application upgrade parameters and starts upgrading the application if the parameters are valid. Note, ApplicationParameters are not… - GETGets details for the latest upgrade performed on this application.
/Applications/:applicationId/$/GetUpgradeProgress?api-version=6.0&timeout=60Returns information about the state of the latest application upgrade along with details to aid debugging application health issues. - POSTUpdates an ongoing application upgrade in the Service Fabric cluster.
/Applications/:applicationId/$/UpdateUpgrade?api-version=6.0&timeout=60Updates the parameters of an ongoing application upgrade from the ones specified at the time of starting the application upgrade. This may be required to… - POSTUpdates a Service Fabric application.
/Applications/:applicationId/$/Update?api-version=8.1&timeout=60Updates a Service Fabric application instance. The set of properties that can be updated are a subset of the properties that were specified at the time of… - POSTResumes upgrading an application in the Service Fabric cluster.
/Applications/:applicationId/$/MoveToNextUpgradeDomain?api-version=6.0&timeout=60Resumes an unmonitored manual Service Fabric application upgrade. Service Fabric upgrades one upgrade domain at a time. For unmonitored manual upgrades, after… - POSTStarts rolling back the currently on-going upgrade of an application in the Service Fabric cluster.
/Applications/:applicationId/$/RollbackUpgrade?api-version=6.0&timeout=60Starts rolling back the current application upgrade to the previous version. This API can only be used to roll back the current in-progress upgrade that is… - GETGets the list of applications deployed on a Service Fabric node.
/Nodes/:nodeName/$/GetApplications?api-version=6.1&timeout=60&IncludeHealthState=false&ContinuationToken=string&MaxResults=0Gets the list of applications deployed on a Service Fabric node. The results do not include information about deployed system applications unless explicitly… - GETGets the information about an application deployed on a Service Fabric node.
/Nodes/:nodeName/$/GetApplications/:applicationId?api-version=6.1&timeout=60&IncludeHealthState=falseThis query returns system application information if the application ID provided is for system application. Results encompass deployed applications in active,… - GETGets the information about health of an application deployed on a Service Fabric node.
/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetHealth?api-version=6.0&EventsHealthStateFilter=0&DeployedServicePackagesHealthStateFilter=0&ExcludeHealthStatistics=false&timeout=60Gets the information about health of an application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of… - POSTGets the information about health of an application deployed on a Service Fabric node. using the specified policy.
/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetHealth?api-version=6.0&EventsHealthStateFilter=0&DeployedServicePackagesHealthStateFilter=0&ExcludeHealthStatistics=false&timeout=60Gets the information about health of an application deployed on a Service Fabric node using the specified policy. Use EventsHealthStateFilter to optionally… - POSTSends a health report on the Service Fabric application deployed on a Service Fabric node.
/Nodes/:nodeName/$/GetApplications/:applicationId/$/ReportHealth?api-version=6.0&Immediate=false&timeout=60Reports health state of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and…
Service
- GETGets the information about all services belonging to the application specified by the application ID.
/Applications/:applicationId/$/GetServices?ServiceTypeName=string&api-version=6.0&ContinuationToken=string&timeout=60Returns the information about all services belonging to the application specified by the application ID. - GETGets the information about the specific service belonging to the Service Fabric application.
/Applications/:applicationId/$/GetServices/:serviceId?api-version=6.0&timeout=60Returns the information about the specified service belonging to the specified Service Fabric application. - GETGets the name of the Service Fabric application for a service.
/Services/:serviceId/$/GetApplicationName?api-version=6.0&timeout=60Gets the name of the application for the specified service. A 404 FABRIC_E_SERVICE_DOES_NOT_EXIST error is returned if a service with the provided service ID… - POSTCreates the specified Service Fabric service.
/Applications/:applicationId/$/GetServices/$/Create?api-version=6.0&timeout=60This api allows creating a new Service Fabric stateless or stateful service under a specified Service Fabric application. The description for creating the… - POSTCreates a Service Fabric service from the service template.
/Applications/:applicationId/$/GetServices/$/CreateFromTemplate?api-version=6.0&timeout=60Creates a Service Fabric service from the service template defined in the application manifest. A service template contains the properties that will be same… - POSTDeletes an existing Service Fabric service.
/Services/:serviceId/$/Delete?api-version=6.0&ForceRemove=true&timeout=60A service must be created before it can be deleted. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the… - POSTUpdates a Service Fabric service using the specified update description.
/Services/:serviceId/$/Update?api-version=6.0&timeout=60This API allows updating properties of a running Service Fabric service. The set of properties that can be updated are a subset of the properties that were… - GETGets the description of an existing Service Fabric service.
/Services/:serviceId/$/GetDescription?api-version=6.0&timeout=60Gets the description of an existing Service Fabric service. A service must be created before its description can be obtained. - GETGets the health of the specified Service Fabric service.
/Services/:serviceId/$/GetHealth?api-version=6.0&EventsHealthStateFilter=0&PartitionsHealthStateFilter=0&ExcludeHealthStatistics=false&timeout=60Gets the health information of the specified service. Use EventsHealthStateFilter to filter the collection of health events reported on the service based on… - POSTGets the health of the specified Service Fabric service, by using the specified health policy.
/Services/:serviceId/$/GetHealth?api-version=6.0&EventsHealthStateFilter=0&PartitionsHealthStateFilter=0&ExcludeHealthStatistics=false&timeout=60Gets the health information of the specified service. If the application health policy is specified, the health evaluation uses it to get the aggregated… - POSTSends a health report on the Service Fabric service.
/Services/:serviceId/$/ReportHealth?api-version=6.0&Immediate=false&timeout=60Reports health state of the specified Service Fabric service. The report must contain the information about the source of the health report and property on… - GETResolve a Service Fabric partition.
/Services/:serviceId/$/ResolvePartition?api-version=6.0&PartitionKeyType=0&PartitionKeyValue=string&PreviousRspVersion=string&timeout=60Resolve a Service Fabric service partition to get the endpoints of the service replicas. - GETGets the information about unplaced replica of the service.
/Services/:serviceId/$/GetUnplacedReplicaInformation?api-version=6.4&PartitionId=3fa85f64-5717-4562-b3fc-2c963f66afa6&OnlyQueryPrimaries=false&timeout=60Returns the information about the unplaced replicas of the service. If PartitionId is specified, then result will contain information only about unplaced…
Partition
- GETGets ordered list of partitions.
/$/GetLoadedPartitionInfoList?api-version=8.0&MetricName=string&ServiceName=string&Ordering=Desc&MaxResults=0&ContinuationToken=stringRetrieves partitions which are most/least loaded according to specified metric. - GETGets the list of partitions of a Service Fabric service.
/Services/:serviceId/$/GetPartitions?api-version=6.4&ContinuationToken=string&timeout=60The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition. - GETGets the information about a Service Fabric partition.
/Partitions/:partitionId?api-version=6.0&timeout=60Gets the information about the specified partition. The response includes the partition ID, partitioning scheme information, keys supported by the partition,… - GETGets the name of the Service Fabric service for a partition.
/Partitions/:partitionId/$/GetServiceName?api-version=6.0&timeout=60Gets name of the service for the specified partition. A 404 error is returned if the partition ID does not exist in the cluster. - GETGets the health of the specified Service Fabric partition.
/Partitions/:partitionId/$/GetHealth?api-version=6.0&EventsHealthStateFilter=0&ReplicasHealthStateFilter=0&ExcludeHealthStatistics=false&timeout=60Use EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state. Use ReplicasHealthStateFilter to… - POSTGets the health of the specified Service Fabric partition, by using the specified health policy.
/Partitions/:partitionId/$/GetHealth?api-version=6.0&EventsHealthStateFilter=0&ReplicasHealthStateFilter=0&ExcludeHealthStatistics=false&timeout=60Gets the health information of the specified partition. If the application health policy is specified, the health evaluation uses it to get the aggregated… - POSTSends a health report on the Service Fabric partition.
/Partitions/:partitionId/$/ReportHealth?api-version=6.0&Immediate=false&timeout=60Reports health state of the specified Service Fabric partition. The report must contain the information about the source of the health report and property on… - GETGets the load information of the specified Service Fabric partition.
/Partitions/:partitionId/$/GetLoadInformation?api-version=6.0&timeout=60Returns information about the load of a specified partition. The response includes a list of load reports for a Service Fabric partition. Each report includes… - POSTResets the current load of a Service Fabric partition.
/Partitions/:partitionId/$/ResetLoad?api-version=6.0&timeout=60Resets the current load of a Service Fabric partition to the default load for the service. - POSTIndicates to the Service Fabric cluster that it should attempt to recover a specific partition that is currently stuck in quorum loss.
/Partitions/:partitionId/$/Recover?api-version=6.0&timeout=60This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data… - POSTIndicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss.
/Services/$/:serviceId/$/GetPartitions/$/Recover?api-version=6.0&timeout=60Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss. This operation should… - POSTIndicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss.
/$/RecoverSystemPartitions?api-version=6.0&timeout=60Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss. This operation should… - POSTIndicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss.
/$/RecoverAllPartitions?api-version=6.0&timeout=60This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data… - POSTMoves the primary replica of a partition of a stateful service.
/Partitions/:partitionId/$/MovePrimaryReplica?api-version=6.5&NodeName=string&IgnoreConstraints=false&timeout=60This command moves the primary replica of a partition of a stateful service, respecting all constraints. If NodeName parameter is specified, primary will be… - POSTMoves the secondary replica of a partition of a stateful service.
/Partitions/:partitionId/$/MoveSecondaryReplica?api-version=6.5&CurrentNodeName=string&NewNodeName=string&IgnoreConstraints=false&timeout=60This command moves the secondary replica of a partition of a stateful service, respecting all constraints. CurrentNodeName parameter must be specified to… - POSTUpdate the loads of provided partitions for specific metrics.
/$/UpdatePartitionLoad?api-version=7.2&ContinuationToken=string&MaxResults=0&timeout=60Updates the load value and predicted load value for all the partitions provided for specified metrics. - POSTMoves the instance of a partition of a stateless service.
/Services/:serviceId/$/GetPartitions/:partitionId/$/MoveInstance?api-version=8.0&CurrentNodeName=string&NewNodeName=string&IgnoreConstraints=false&timeout=60This command moves the instance of a partition of a stateless service, respecting all constraints. Partition id and service name must be specified to be able… - POSTMoves the auxiliary replica of a partition of a stateful service.
/Services/:serviceId/$/GetPartitions/:partitionId/$/MoveAuxiliaryReplica?api-version=8.1&CurrentNodeName=string&NewNodeName=string&IgnoreConstraints=false&timeout=60This command moves the auxiliary replica of a partition of a stateful service, respecting all constraints. CurrentNodeName can be omitted, and in that case a…
RepairManagement
- POSTCreates a new repair task.
/$/CreateRepairTask?api-version=6.0For clusters that have the Repair Manager Service configured, this API provides a way to create repair tasks that run automatically or manually. For repair… - POSTRequests the cancellation of the given repair task.
/$/CancelRepairTask?api-version=6.0This API supports the Service Fabric platform; it is not meant to be used directly from your code. - POSTDeletes a completed repair task.
/$/DeleteRepairTask?api-version=6.0This API supports the Service Fabric platform; it is not meant to be used directly from your code. - GETGets a list of repair tasks matching the given filters.
/$/GetRepairTaskList?api-version=6.0&TaskIdFilter=string&StateFilter=0&ExecutorFilter=stringThis API supports the Service Fabric platform; it is not meant to be used directly from your code. - POSTForces the approval of the given repair task.
/$/ForceApproveRepairTask?api-version=6.0This API supports the Service Fabric platform; it is not meant to be used directly from your code. - POSTUpdates the health policy of the given repair task.
/$/UpdateRepairTaskHealthPolicy?api-version=6.0This API supports the Service Fabric platform; it is not meant to be used directly from your code. - POSTUpdates the execution state of a repair task.
/$/UpdateRepairExecutionState?api-version=6.0This API supports the Service Fabric platform; it is not meant to be used directly from your code.
Replica
- GETGets the information about replicas of a Service Fabric service partition.
/Partitions/:partitionId/$/GetReplicas?api-version=6.0&ContinuationToken=string&timeout=60The GetReplicas endpoint returns information about the replicas of the specified partition. The response includes the ID, role, status, health, node name,… - GETGets the information about a replica of a Service Fabric partition.
/Partitions/:partitionId/$/GetReplicas/:replicaId?api-version=6.0&timeout=60The response includes the ID, role, status, health, node name, uptime, and other details about the replica. - GETGets the health of a Service Fabric stateful service replica or stateless service instance.
/Partitions/:partitionId/$/GetReplicas/:replicaId/$/GetHealth?api-version=6.0&EventsHealthStateFilter=0&timeout=60Gets the health of a Service Fabric replica. Use EventsHealthStateFilter to filter the collection of health events reported on the replica based on the health… - POSTGets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy.
/Partitions/:partitionId/$/GetReplicas/:replicaId/$/GetHealth?api-version=6.0&EventsHealthStateFilter=0&timeout=60Gets the health of a Service Fabric stateful service replica or stateless service instance. Use EventsHealthStateFilter to filter the collection of health… - POSTSends a health report on the Service Fabric replica.
/Partitions/:partitionId/$/GetReplicas/:replicaId/$/ReportHealth?api-version=6.0&ServiceKind=Stateful&Immediate=false&timeout=60Reports health state of the specified Service Fabric replica. The report must contain the information about the source of the health report and property on… - GETGets the list of replicas deployed on a Service Fabric node.
/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetReplicas?api-version=6.0&PartitionId=3fa85f64-5717-4562-b3fc-2c963f66afa6&ServiceManifestName=string&timeout=60Gets the list containing the information about replicas deployed on a Service Fabric node. The information include partition ID, replica ID, status of the… - GETGets the details of replica deployed on a Service Fabric node.
/Nodes/:nodeName/$/GetPartitions/:partitionId/$/GetReplicas/:replicaId/$/GetDetail?api-version=6.0&timeout=60Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current… - GETGets the details of replica deployed on a Service Fabric node.
/Nodes/:nodeName/$/GetPartitions/:partitionId/$/GetReplicas?api-version=6.0&timeout=60Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current… - POSTRestarts a service replica of a persisted service running on a node.
/Nodes/:nodeName/$/GetPartitions/:partitionId/$/GetReplicas/:replicaId/$/Restart?api-version=6.0&timeout=60Restarts a service replica of a persisted service running on a node. Warning - There are no safety checks performed when this API is used. Incorrect use of… - POSTRemoves a service replica running on a node.
/Nodes/:nodeName/$/GetPartitions/:partitionId/$/GetReplicas/:replicaId/$/Delete?api-version=6.0&ForceRemove=true&timeout=60This API simulates a Service Fabric replica failure by removing a replica from a Service Fabric cluster. The removal closes the replica, transitions the…
Service Package
- GETGets the list of service packages deployed on a Service Fabric node.
/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetServicePackages?api-version=6.0&timeout=60Returns the information about the service packages deployed on a Service Fabric node for the given application. - GETGets the list of service packages deployed on a Service Fabric node matching exactly the specified name.
/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetServicePackages/:servicePackageName?api-version=6.0&timeout=60Returns the information about the service packages deployed on a Service Fabric node for the given application. These results are of service packages whose… - GETGets the information about health of a service package for a specific application deployed for a Service Fabric node and application.
/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetServicePackages/:servicePackageName/$/GetHealth?api-version=6.0&EventsHealthStateFilter=0&timeout=60Gets the information about health of a service package for a specific application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally… - POSTGets the information about health of service package for a specific application deployed on a Service Fabric node using the specified policy.
/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetServicePackages/:servicePackageName/$/GetHealth?api-version=6.0&EventsHealthStateFilter=0&timeout=60Gets the information about health of a service package for a specific application deployed on a Service Fabric node. using the specified policy. Use… - POSTSends a health report on the Service Fabric deployed service package.
/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetServicePackages/:servicePackageName/$/ReportHealth?api-version=6.0&Immediate=false&timeout=60Reports health state of the service package of the application deployed on a Service Fabric node. The report must contain the information about the source of… - POSTDownloads all of the code packages associated with specified service manifest on the specified node.
/Nodes/:nodeName/$/DeployServicePackage?api-version=6.0&timeout=60This API provides a way to download code packages including the container images on a specific node outside of the normal application deployment and upgrade…
Code Package
- GETGets the list of code packages deployed on a Service Fabric node.
/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetCodePackages?api-version=6.0&ServiceManifestName=string&CodePackageName=string&timeout=60Gets the list of code packages deployed on a Service Fabric node for the given application. - POSTRestarts a code package deployed on a Service Fabric node in a cluster.
/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetCodePackages/$/Restart?api-version=6.0&timeout=60Restarts a code package deployed on a Service Fabric node in a cluster. This aborts the code package process, which will restart all the user service replicas… - GETGets the container logs for container deployed on a Service Fabric node.
/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetCodePackages/$/ContainerLogs?api-version=6.2&ServiceManifestName=string&CodePackageName=string&Tail=string&Previous=false&timeout=60Gets the container logs for container deployed on a Service Fabric node for the given code package. - POSTInvoke container API on a container deployed on a Service Fabric node.
/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetCodePackages/$/ContainerApi?api-version=6.2&ServiceManifestName=string&CodePackageName=string&CodePackageInstanceId=string&timeout=60Invoke container API on a container deployed on a Service Fabric node for the given code package.
Compose Deployment
- PUTCreates a Service Fabric compose deployment.
/ComposeDeployments/$/Create?api-version=6.0-preview&timeout=60Compose is a file format that describes multi-container applications. This API allows deploying container based applications defined in compose format in a… - GETGets information about a Service Fabric compose deployment.
/ComposeDeployments/:deploymentName?api-version=6.0-preview&timeout=60Returns the status of the compose deployment that was created or in the process of being created in the Service Fabric cluster and whose name matches the one… - GETGets the list of compose deployments created in the Service Fabric cluster.
/ComposeDeployments?api-version=6.0-preview&ContinuationToken=string&MaxResults=0&timeout=60Gets the status about the compose deployments that were created or in the process of being created in the Service Fabric cluster. The response includes the… - GETGets details for the latest upgrade performed on this Service Fabric compose deployment.
/ComposeDeployments/:deploymentName/$/GetUpgradeProgress?api-version=6.0-preview&timeout=60Returns the information about the state of the compose deployment upgrade along with details to aid debugging application health issues. - POSTDeletes an existing Service Fabric compose deployment from cluster.
/ComposeDeployments/:deploymentName/$/Delete?api-version=6.0-preview&timeout=60Deletes an existing Service Fabric compose deployment. - POSTStarts upgrading a compose deployment in the Service Fabric cluster.
/ComposeDeployments/:deploymentName/$/Upgrade?api-version=6.0-preview&timeout=60Validates the supplied upgrade parameters and starts upgrading the deployment if the parameters are valid. - POSTStarts rolling back a compose deployment upgrade in the Service Fabric cluster.
/ComposeDeployments/:deploymentName/$/RollbackUpgrade?api-version=6.4-preview&timeout=60Rollback a service fabric compose deployment upgrade.
Chaos
- GETGet the status of Chaos.
/Tools/Chaos?api-version=6.2&timeout=60Get the status of Chaos indicating whether or not Chaos is running, the Chaos parameters used for running Chaos and the status of the Chaos Schedule. - POSTStarts Chaos in the cluster.
/Tools/Chaos/$/Start?api-version=6.0&timeout=60If Chaos is not already running in the cluster, it starts Chaos with the passed in Chaos parameters. If Chaos is already running when this call is made, the… - POSTStops Chaos if it is running in the cluster and put the Chaos Schedule in a stopped state.
/Tools/Chaos/$/Stop?api-version=6.0&timeout=60Stops Chaos from executing new faults. In-flight faults will continue to execute until they are complete. The current Chaos Schedule is put into a stopped… - GETGets the next segment of the Chaos events based on the continuation token or the time range.
/Tools/Chaos/Events?api-version=6.2&ContinuationToken=string&StartTimeUtc=string&EndTimeUtc=string&MaxResults=0&timeout=60To get the next segment of the Chaos events, you can specify the ContinuationToken. To get the start of a new segment of Chaos events, you can specify the… - GETGet the Chaos Schedule defining when and how to run Chaos.
/Tools/Chaos/Schedule?api-version=6.2&timeout=60Gets the version of the Chaos Schedule in use and the Chaos Schedule that defines when and how to run Chaos. - POSTSet the schedule used by Chaos.
/Tools/Chaos/Schedule?api-version=6.2&timeout=60Chaos will automatically schedule runs based on the Chaos Schedule. The Chaos Schedule will be updated if the provided version matches the version on the…
ImageStore
- GETGets the image store content information.
/ImageStore/:contentPath?api-version=6.2&timeout=60Returns the information about the image store content at the specified contentPath. The contentPath is relative to the root of the image store. - PUTUploads contents of the file to the image store.
/ImageStore/:contentPath?api-version=6.0&timeout=60Uploads contents of the file to the image store. Use this API if the file is small enough to upload again if the connection fails. The file's data needs to be… - DELETEDeletes existing image store content.
/ImageStore/:contentPath?api-version=6.0&timeout=60Deletes existing image store content being found within the given image store relative path. This command can be used to delete uploaded application packages… - GETGets the content information at the root of the image store.
/ImageStore?api-version=6.0&timeout=60Returns the information about the image store content at the root of the image store. - POSTCopies image store content internally
/ImageStore/$/Copy?api-version=6.0&timeout=60Copies the image store content from the source image store relative path to the destination image store relative path. - DELETECancels an image store upload session.
/ImageStore/$/DeleteUploadSession?api-version=6.0&session-id=3fa85f64-5717-4562-b3fc-2c963f66afa6&timeout=60The DELETE request will cause the existing upload session to expire and remove any previously uploaded file chunks. - POSTCommit an image store upload session.
/ImageStore/$/CommitUploadSession?api-version=6.0&session-id=3fa85f64-5717-4562-b3fc-2c963f66afa6&timeout=60When all file chunks have been uploaded, the upload session needs to be committed explicitly to complete the upload. Image store preserves the upload session… - GETGet the image store upload session by ID.
/ImageStore/$/GetUploadSession?api-version=6.0&session-id=3fa85f64-5717-4562-b3fc-2c963f66afa6&timeout=60Gets the image store upload session identified by the given ID. User can query the upload session at any time during uploading. - GETGet the image store upload session by relative path.
/ImageStore/:contentPath/$/GetUploadSession?api-version=6.0&timeout=60Gets the image store upload session associated with the given image store relative path. User can query the upload session at any time during uploading. - PUTUploads a file chunk to the image store relative path.
/ImageStore/:contentPath/$/UploadChunk?api-version=6.0&session-id=3fa85f64-5717-4562-b3fc-2c963f66afa6&timeout=60Uploads a file chunk to the image store with the specified upload session ID and image store relative path. This API allows user to resume the file upload… - GETGet the folder size at the root of the image store.
/ImageStore/$/FolderSize?api-version=6.5&timeout=60Returns the total size of files at the root and children folders in image store. - GETGet the size of a folder in image store
/ImageStore/:contentPath/$/FolderSize?api-version=6.5&timeout=60Gets the total size of file under a image store folder, specified by contentPath. The contentPath is relative to the root of the image store. - GETGets the overall ImageStore information
/ImageStore/$/Info?api-version=6.5&timeout=60Returns information about the primary ImageStore replica, such as disk capacity and available disk space at the node it is on, and several categories of the…
Infrastructure
- POSTInvokes an administrative command on the given Infrastructure Service instance.
/$/InvokeInfrastructureCommand?api-version=6.0&Command=string&ServiceId=string&timeout=60For clusters that have one or more instances of the Infrastructure Service configured, this API provides a way to send infrastructure-specific commands to a… - GETInvokes a read-only query on the given infrastructure service instance.
/$/InvokeInfrastructureQuery?api-version=6.0&Command=string&ServiceId=string&timeout=60For clusters that have one or more instances of the Infrastructure Service configured, this API provides a way to send infrastructure-specific queries to a…
Faults
- POSTThis API will induce data loss for the specified partition. It will trigger a call to the OnDataLossAsync API of the partition.
/Faults/Services/:serviceId/$/GetPartitions/:partitionId/$/StartDataLoss?api-version=6.0&OperationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&DataLossMode=Invalid&timeout=60This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition. Actual data loss will depend on the… - GETGets the progress of a partition data loss operation started using the StartDataLoss API.
/Faults/Services/:serviceId/$/GetPartitions/:partitionId/$/GetDataLossProgress?api-version=6.0&OperationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&timeout=60Gets the progress of a data loss operation started with StartDataLoss, using the OperationId. - POSTInduces quorum loss for a given stateful service partition.
/Faults/Services/:serviceId/$/GetPartitions/:partitionId/$/StartQuorumLoss?api-version=6.0&OperationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&QuorumLossMode=Invalid&QuorumLossDuration=0&timeout=60This API is useful for a temporary quorum loss situation on your service. Call the GetQuorumLossProgress API with the same OperationId to return information… - GETGets the progress of a quorum loss operation on a partition started using the StartQuorumLoss API.
/Faults/Services/:serviceId/$/GetPartitions/:partitionId/$/GetQuorumLossProgress?api-version=6.0&OperationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&timeout=60Gets the progress of a quorum loss operation started with StartQuorumLoss, using the provided OperationId. - POSTThis API will restart some or all replicas or instances of the specified partition.
/Faults/Services/:serviceId/$/GetPartitions/:partitionId/$/StartRestart?api-version=6.0&OperationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&RestartPartitionMode=Invalid&timeout=60This API is useful for testing failover. If used to target a stateless service partition, RestartPartitionMode must be AllReplicasOrInstances. Call the… - GETGets the progress of a PartitionRestart operation started using StartPartitionRestart.
/Faults/Services/:serviceId/$/GetPartitions/:partitionId/$/GetRestartProgress?api-version=6.0&OperationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&timeout=60Gets the progress of a PartitionRestart started with StartPartitionRestart using the provided OperationId. - POSTStarts or stops a cluster node.
/Faults/Nodes/:nodeName/$/StartTransition/?api-version=6.0&OperationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&NodeTransitionType=Invalid&NodeInstanceId=string&StopDurationInSeconds=0&timeout=60Starts or stops a cluster node. A cluster node is a process, not the OS instance itself. To start a node, pass in "Start" for the NodeTransitionType… - GETGets the progress of an operation started using StartNodeTransition.
/Faults/Nodes/:nodeName/$/GetTransitionProgress?api-version=6.0&OperationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&timeout=60Gets the progress of an operation started with StartNodeTransition using the provided OperationId. - GETGets a list of user-induced fault operations filtered by provided input.
/Faults/?api-version=6.0&TypeFilter=65535&StateFilter=65535&timeout=60Gets the list of user-induced fault operations filtered by provided input. - POSTCancels a user-induced fault operation.
/Faults/$/Cancel?api-version=6.0&OperationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&Force=false&timeout=60The following APIs start fault operations that may be cancelled by using CancelOperation: StartDataLoss, StartQuorumLoss, StartPartitionRestart,…
BackupRestore
- POSTCreates a backup policy.
/BackupRestore/BackupPolicies/$/Create?api-version=6.4&timeout=60&ValidateConnection=falseCreates a backup policy which can be associated later with a Service Fabric application, service or a partition for periodic backup. - POSTDeletes the backup policy.
/BackupRestore/BackupPolicies/:backupPolicyName/$/Delete?api-version=6.4&timeout=60Deletes an existing backup policy. A backup policy must be created before it can be deleted. A currently active backup policy, associated with any Service… - GETGets all the backup policies configured.
/BackupRestore/BackupPolicies?api-version=6.4&ContinuationToken=string&MaxResults=0&timeout=60Get a list of all the backup policies configured. - GETGets a particular backup policy by name.
/BackupRestore/BackupPolicies/:backupPolicyName?api-version=6.4&timeout=60Gets a particular backup policy identified by {backupPolicyName} - GETGets the list of backup entities that are associated with this policy.
/BackupRestore/BackupPolicies/:backupPolicyName/$/GetBackupEnabledEntities?api-version=6.4&ContinuationToken=string&MaxResults=0&timeout=60Returns a list of Service Fabric application, service or partition which are associated with this backup policy. - POSTUpdates the backup policy.
/BackupRestore/BackupPolicies/:backupPolicyName/$/Update?api-version=6.4&timeout=60&ValidateConnection=falseUpdates the backup policy identified by {backupPolicyName} - POSTEnables periodic backup of stateful partitions under this Service Fabric application.
/Applications/:applicationId/$/EnableBackup?api-version=6.4&timeout=60Enables periodic backup of stateful partitions which are part of this Service Fabric application. Each partition is backed up individually as per the… - POSTDisables periodic backup of Service Fabric application.
/Applications/:applicationId/$/DisableBackup?api-version=6.4&timeout=60Disables periodic backup of Service Fabric application which was previously enabled. - GETGets the Service Fabric application backup configuration information.
/Applications/:applicationId/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken=string&MaxResults=0&timeout=60Gets the Service Fabric backup configuration information for the application and the services and partitions under this application. - GETGets the list of backups available for every partition in this application.
/Applications/:applicationId/$/GetBackups?api-version=6.4&timeout=60&Latest=false&StartDateTimeFilter=2024-01-01T00:00:00Z&EndDateTimeFilter=2024-01-01T00:00:00Z&ContinuationToken=string&MaxResults=0Returns a list of backups available for every partition in this Service Fabric application. The server enumerates all the backups available at the backup… - POSTSuspends periodic backup for the specified Service Fabric application.
/Applications/:applicationId/$/SuspendBackup?api-version=6.4&timeout=60The application which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the… - POSTResumes periodic backup of a Service Fabric application which was previously suspended.
/Applications/:applicationId/$/ResumeBackup?api-version=6.4&timeout=60The previously suspended Service Fabric application resumes taking periodic backup as per the backup policy currently configured for the same. - POSTEnables periodic backup of stateful partitions under this Service Fabric service.
/Services/:serviceId/$/EnableBackup?api-version=6.4&timeout=60Enables periodic backup of stateful partitions which are part of this Service Fabric service. Each partition is backed up individually as per the specified… - POSTDisables periodic backup of Service Fabric service which was previously enabled.
/Services/:serviceId/$/DisableBackup?api-version=6.4&timeout=60Disables periodic backup of Service Fabric service which was previously enabled. Backup must be explicitly enabled before it can be disabled. In case the… - GETGets the Service Fabric service backup configuration information.
/Services/:serviceId/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken=string&MaxResults=0&timeout=60Gets the Service Fabric backup configuration information for the service and the partitions under this service. - GETGets the list of backups available for every partition in this service.
/Services/:serviceId/$/GetBackups?api-version=6.4&timeout=60&Latest=false&StartDateTimeFilter=2024-01-01T00:00:00Z&EndDateTimeFilter=2024-01-01T00:00:00Z&ContinuationToken=string&MaxResults=0Returns a list of backups available for every partition in this Service Fabric service. The server enumerates all the backups available in the backup store… - POSTSuspends periodic backup for the specified Service Fabric service.
/Services/:serviceId/$/SuspendBackup?api-version=6.4&timeout=60The service which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the… - POSTResumes periodic backup of a Service Fabric service which was previously suspended.
/Services/:serviceId/$/ResumeBackup?api-version=6.4&timeout=60The previously suspended Service Fabric service resumes taking periodic backup as per the backup policy currently configured for the same. - POSTEnables periodic backup of the stateful persisted partition.
/Partitions/:partitionId/$/EnableBackup?api-version=6.4&timeout=60Enables periodic backup of stateful persisted partition. Each partition is backed up as per the specified backup policy description. In case the application… - POSTDisables periodic backup of Service Fabric partition which was previously enabled.
/Partitions/:partitionId/$/DisableBackup?api-version=6.4&timeout=60Disables periodic backup of partition which was previously enabled. Backup must be explicitly enabled before it can be disabled. In case the backup is enabled… - GETGets the partition backup configuration information
/Partitions/:partitionId/$/GetBackupConfigurationInfo?api-version=6.4&timeout=60Gets the Service Fabric Backup configuration information for the specified partition. - GETGets the list of backups available for the specified partition.
/Partitions/:partitionId/$/GetBackups?api-version=6.4&timeout=60&Latest=false&StartDateTimeFilter=2024-01-01T00:00:00Z&EndDateTimeFilter=2024-01-01T00:00:00ZReturns a list of backups available for the specified partition. The server enumerates all the backups available in the backup store configured in the backup… - POSTSuspends periodic backup for the specified partition.
/Partitions/:partitionId/$/SuspendBackup?api-version=6.4&timeout=60The partition which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. - POSTResumes periodic backup of partition which was previously suspended.
/Partitions/:partitionId/$/ResumeBackup?api-version=6.4&timeout=60The previously suspended partition resumes taking periodic backup as per the backup policy currently configured for the same. - POSTTriggers backup of the partition's state.
/Partitions/:partitionId/$/Backup?BackupTimeout=10&api-version=6.4&timeout=60Creates a backup of the stateful persisted partition's state. In case the partition is already being periodically backed up, then by default the new backup is… - GETGets details for the latest backup triggered for this partition.
/Partitions/:partitionId/$/GetBackupProgress?api-version=6.4&timeout=60Returns information about the state of the latest backup along with details or failure reason in case of completion. - POSTTriggers restore of the state of the partition using the specified restore partition description.
/Partitions/:partitionId/$/Restore?RestoreTimeout=10&api-version=6.4&timeout=60Restores the state of a of the stateful persisted partition using the specified backup point. In case the partition is already being periodically backed up,… - GETGets details for the latest restore operation triggered for this partition.
/Partitions/:partitionId/$/GetRestoreProgress?api-version=6.4&timeout=60Returns information about the state of the latest restore operation along with details or failure reason in case of completion. - POSTGets the list of backups available for the specified backed up entity at the specified backup location.
/BackupRestore/$/GetBackups?api-version=6.4&timeout=60&ContinuationToken=string&MaxResults=0Gets the list of backups available for the specified backed up entity (Application, Service or Partition) at the specified backup location (FileShare or Azure…
Property Management
- POSTCreates a Service Fabric name.
/Names/$/Create?api-version=6.0&timeout=60Creates the specified Service Fabric name. - GETReturns whether the Service Fabric name exists.
/Names/:nameId?api-version=6.0&timeout=60Returns whether the specified Service Fabric name exists. - DELETEDeletes a Service Fabric name.
/Names/:nameId?api-version=6.0&timeout=60Deletes the specified Service Fabric name. A name must be created before it can be deleted. Deleting a name with child properties will fail. - GETEnumerates all the Service Fabric names under a given name.
/Names/:nameId/$/GetSubNames?api-version=6.0&Recursive=false&ContinuationToken=string&timeout=60Enumerates all the Service Fabric names under a given name. If the subnames do not fit in a page, one page of results is returned as well as a continuation… - GETGets information on all Service Fabric properties under a given name.
/Names/:nameId/$/GetProperties?api-version=6.0&IncludeValues=false&ContinuationToken=string&timeout=60A Service Fabric name can have one or more named properties that store custom information. This operation gets the information about these properties in a… - GETGets the specified Service Fabric property.
/Names/:nameId/$/GetProperty?api-version=6.0&PropertyName=string&timeout=60Gets the specified Service Fabric property under a given name. This will always return both value and metadata. - PUTCreates or updates a Service Fabric property.
/Names/:nameId/$/GetProperty?api-version=6.0&timeout=60Creates or updates the specified Service Fabric property under a given name. - DELETEDeletes the specified Service Fabric property.
/Names/:nameId/$/GetProperty?api-version=6.0&PropertyName=string&timeout=60Deletes the specified Service Fabric property under a given name. A property must be created before it can be deleted. - POSTSubmits a property batch.
/Names/:nameId/$/GetProperties/$/SubmitBatch?api-version=6.0&timeout=60Submits a batch of property operations. Either all or none of the operations will be committed.
EventsStore
- GETGets all Cluster-related events.
/EventsStore/Cluster/Events?api-version=6.4&timeout=60&StartTimeUtc=string&EndTimeUtc=string&EventsTypesFilter=string&ExcludeAnalysisEvents=true&SkipCorrelationLookup=trueThe response is list of ClusterEvent objects. - GETGets all Containers-related events.
/EventsStore/Containers/Events?api-version=6.2-preview&timeout=60&StartTimeUtc=string&EndTimeUtc=string&EventsTypesFilter=string&ExcludeAnalysisEvents=true&SkipCorrelationLookup=trueThe response is list of ContainerInstanceEvent objects. - GETGets a Node-related events.
/EventsStore/Nodes/:nodeName/$/Events?api-version=6.4&timeout=60&StartTimeUtc=string&EndTimeUtc=string&EventsTypesFilter=string&ExcludeAnalysisEvents=true&SkipCorrelationLookup=trueThe response is list of NodeEvent objects. - GETGets all Nodes-related Events.
/EventsStore/Nodes/Events?api-version=6.4&timeout=60&StartTimeUtc=string&EndTimeUtc=string&EventsTypesFilter=string&ExcludeAnalysisEvents=true&SkipCorrelationLookup=trueThe response is list of NodeEvent objects. - GETGets an Application-related events.
/EventsStore/Applications/:applicationId/$/Events?api-version=6.4&timeout=60&StartTimeUtc=string&EndTimeUtc=string&EventsTypesFilter=string&ExcludeAnalysisEvents=true&SkipCorrelationLookup=trueThe response is list of ApplicationEvent objects. - GETGets all Applications-related events.
/EventsStore/Applications/Events?api-version=6.4&timeout=60&StartTimeUtc=string&EndTimeUtc=string&EventsTypesFilter=string&ExcludeAnalysisEvents=true&SkipCorrelationLookup=trueThe response is list of ApplicationEvent objects. - GETGets a Service-related events.
/EventsStore/Services/:serviceId/$/Events?api-version=6.4&timeout=60&StartTimeUtc=string&EndTimeUtc=string&EventsTypesFilter=string&ExcludeAnalysisEvents=true&SkipCorrelationLookup=trueThe response is list of ServiceEvent objects. - GETGets all Services-related events.
/EventsStore/Services/Events?api-version=6.4&timeout=60&StartTimeUtc=string&EndTimeUtc=string&EventsTypesFilter=string&ExcludeAnalysisEvents=true&SkipCorrelationLookup=trueThe response is list of ServiceEvent objects. - GETGets a Partition-related events.
/EventsStore/Partitions/:partitionId/$/Events?api-version=6.4&timeout=60&StartTimeUtc=string&EndTimeUtc=string&EventsTypesFilter=string&ExcludeAnalysisEvents=true&SkipCorrelationLookup=trueThe response is list of PartitionEvent objects. - GETGets all Partitions-related events.
/EventsStore/Partitions/Events?api-version=6.4&timeout=60&StartTimeUtc=string&EndTimeUtc=string&EventsTypesFilter=string&ExcludeAnalysisEvents=true&SkipCorrelationLookup=trueThe response is list of PartitionEvent objects. - GETGets a Partition Replica-related events.
/EventsStore/Partitions/:partitionId/$/Replicas/:replicaId/$/Events?api-version=6.4&timeout=60&StartTimeUtc=string&EndTimeUtc=string&EventsTypesFilter=string&ExcludeAnalysisEvents=true&SkipCorrelationLookup=trueThe response is list of ReplicaEvent objects. - GETGets all Replicas-related events for a Partition.
/EventsStore/Partitions/:partitionId/$/Replicas/Events?api-version=6.4&timeout=60&StartTimeUtc=string&EndTimeUtc=string&EventsTypesFilter=string&ExcludeAnalysisEvents=true&SkipCorrelationLookup=trueThe response is list of ReplicaEvent objects. - GETGets all correlated events for a given event.
/EventsStore/CorrelatedEvents/:eventInstanceId/$/Events?api-version=6.4&timeout=60The response is list of FabricEvents.
MeshSecrets
- GETGets the Secret resource with the given name.
/Resources/Secrets/:secretResourceName?api-version=6.4-previewGets the information about the Secret resource with the given name. The information include the description and other properties of the Secret. - PUTCreates or updates a Secret resource.
/Resources/Secrets/:secretResourceName?api-version=6.4-previewCreates a Secret resource with the specified name, description and properties. If Secret resource with the same name exists, then it is updated with the… - DELETEDeletes the Secret resource.
/Resources/Secrets/:secretResourceName?api-version=6.4-previewDeletes the specified Secret resource and all of its named values. - GETLists all the secret resources.
/Resources/Secrets?api-version=6.4-previewGets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.
MeshSecretValues
- GETGets the specified secret value resource.
/Resources/Secrets/:secretResourceName/values/:secretValueResourceName?api-version=6.4-previewGet the information about the specified named secret value resources. The information does not include the actual value of the secret. - PUTAdds the specified value as a new version of the specified secret resource.
/Resources/Secrets/:secretResourceName/values/:secretValueResourceName?api-version=6.4-previewCreates a new value of the specified secret resource. The name of the value is typically the version identifier. Once created the value cannot be changed. - DELETEDeletes the specified value of the named secret resource.
/Resources/Secrets/:secretResourceName/values/:secretValueResourceName?api-version=6.4-previewDeletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if… - GETList names of all values of the specified secret resource.
/Resources/Secrets/:secretResourceName/values?api-version=6.4-previewGets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not… - POSTLists the specified value of the secret resource.
/Resources/Secrets/:secretResourceName/values/:secretValueResourceName/list_value?api-version=6.4-previewLists the decrypted value of the specified named value of the secret resource. This is a privileged operation.
MeshVolumes
- GETGets the Volume resource with the given name.
/Resources/Volumes/:volumeResourceName?api-version=6.4-previewGets the information about the Volume resource with the given name. The information include the description and other properties of the Volume. - PUTCreates or updates a Volume resource.
/Resources/Volumes/:volumeResourceName?api-version=6.4-previewCreates a Volume resource with the specified name, description and properties. If Volume resource with the same name exists, then it is updated with the… - DELETEDeletes the Volume resource.
/Resources/Volumes/:volumeResourceName?api-version=6.4-previewDeletes the Volume resource identified by the name. - GETLists all the volume resources.
/Resources/Volumes?api-version=6.4-previewGets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.
MeshNetworks
- GETGets the Network resource with the given name.
/Resources/Networks/:networkResourceName?api-version=6.4-previewGets the information about the Network resource with the given name. The information include the description and other properties of the Network. - PUTCreates or updates a Network resource.
/Resources/Networks/:networkResourceName?api-version=6.4-previewCreates a Network resource with the specified name, description and properties. If Network resource with the same name exists, then it is updated with the… - DELETEDeletes the Network resource.
/Resources/Networks/:networkResourceName?api-version=6.4-previewDeletes the Network resource identified by the name. - GETLists all the network resources.
/Resources/Networks?api-version=6.4-previewGets the information about all network resources in a given resource group. The information include the description and other properties of the Network.
MeshApplications
- GETGets the Application resource with the given name.
/Resources/Applications/:applicationResourceName?api-version=6.4-previewGets the information about the Application resource with the given name. The information include the description and other properties of the Application. - PUTCreates or updates a Application resource.
/Resources/Applications/:applicationResourceName?api-version=6.4-previewCreates a Application resource with the specified name, description and properties. If Application resource with the same name exists, then it is updated with… - DELETEDeletes the Application resource.
/Resources/Applications/:applicationResourceName?api-version=6.4-previewDeletes the Application resource identified by the name. - GETLists all the application resources.
/Resources/Applications?api-version=6.4-previewGets the information about all application resources in a given resource group. The information include the description and other properties of the Application. - GETGets the progress of the latest upgrade performed on this application resource.
/Resources/Applications/:applicationResourceName/$/GetUpgradeProgress?api-version=7.0Gets the upgrade progress information about the Application resource with the given name. The information include percentage of completion and other upgrade…
MeshServices
- GETGets the Service resource with the given name.
/Resources/Applications/:applicationResourceName/Services/:serviceResourceName?api-version=6.4-previewGets the information about the Service resource with the given name. The information include the description and other properties of the Service. - GETLists all the service resources.
/Resources/Applications/:applicationResourceName/Services?api-version=6.4-previewGets the information about all services of an application resource. The information include the description and other properties of the Service.
MeshCodePackages
- GETGets the logs from the container.
/Resources/Applications/:applicationResourceName/Services/:serviceResourceName/Replicas/:replicaName/CodePackages/:codePackageName/Logs?api-version=6.4-preview&Tail=stringGets the logs for the container of the specified code package of the service replica.
MeshServiceReplicas
- GETGets the given replica of the service of an application.
/Resources/Applications/:applicationResourceName/Services/:serviceResourceName/Replicas/:replicaName?api-version=6.4-previewGets the information about the service replica with the given name. The information include the description and other properties of the service replica. - GETLists all the replicas of a service.
/Resources/Applications/:applicationResourceName/Services/:serviceResourceName/Replicas?api-version=6.4-previewGets the information about all replicas of a service. The information include the description and other properties of the service replica.
MeshGateways
- GETGets the Gateway resource with the given name.
/Resources/Gateways/:gatewayResourceName?api-version=6.4-previewGets the information about the Gateway resource with the given name. The information include the description and other properties of the Gateway. - PUTCreates or updates a Gateway resource.
/Resources/Gateways/:gatewayResourceName?api-version=6.4-previewCreates a Gateway resource with the specified name, description and properties. If Gateway resource with the same name exists, then it is updated with the… - DELETEDeletes the Gateway resource.
/Resources/Gateways/:gatewayResourceName?api-version=6.4-previewDeletes the Gateway resource identified by the name. - GETLists all the gateway resources.
/Resources/Gateways?api-version=6.4-previewGets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.
API details
- Base URL
https://localhost:19080- Authentication
- None declared in the description
- Operations
- 247 operations on 220 pathsGET 123POST 103DELETE 11PUT 10
- Main resources
- BackupRestore 29Cluster 25Application 19Partition 18Node 15EventsStore 13ImageStore 13Service 13Faults 10Replica 10
- Response formats
application/json- Description format
- Swagger 2.0, API version
8.2 - Links
- OpenAPI document
How to test the Azure Servicefabric in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Servicefabric collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Get the Service Fabric cluster manifest.” (GET /$/GetClusterManifest?api-version=6.0&timeout=60), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Servicefabric?
Service Fabric REST Client APIs allows management of Service Fabric clusters, applications and services. It is listed under Developer tools and has 247 endpoints.
Who publishes the Azure Servicefabric?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Azure Servicefabric?
Requests go to https://localhost:19080. Endpoint paths are added to this base URL.
How do I authenticate with the Azure Servicefabric?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Azure Servicefabric have?
247 operations on 220 paths (123 GET, 103 POST, 11 DELETE, 10 PUT). The largest groups are BackupRestore, Cluster, Application, Partition.
Is forking the Azure Servicefabric free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.