Service Fabric Client APIs
Service Fabric REST Client APIs allows management of Service Fabric clusters, applications and services.
https://azure.comEndpoints
234 endpoints available
/NodesGets the list of nodes in the Service Fabric cluster.
/Faults/Gets a list of user-induced fault operations filtered by provided input.
/$/UpgradeStart upgrading the code or configuration version of a Service Fabric cluster.
/ImageStoreGets the content information at the root of the image store.
/$/ProvisionProvision the code or configuration packages of a Service Fabric cluster.
/Tools/ChaosGet the status of Chaos.
/ApplicationsGets the list of applications created in the Service Fabric cluster that match the specified filters.
/$/UnprovisionUnprovision the code or configuration packages of a Service Fabric cluster.
/Names/$/CreateCreates a Service Fabric name.
/Names/{nameId}Returns whether the Service Fabric name exists.
/Names/{nameId}Deletes a Service Fabric name.
/$/UpdateUpgradeUpdate the upgrade parameters of a Service Fabric cluster upgrade.
/Faults/$/CancelCancels a user-induced fault operation.
/$/GetAadMetadataGets the Azure Active Directory metadata used for secured connection to cluster.
/ApplicationTypesGets the list of application types in the Service Fabric cluster.
/Nodes/{nodeName}Gets the information about a specific node in the Service Fabric cluster.
/$/RollbackUpgradeRoll back the upgrade of a Service Fabric cluster.
/ImageStore/$/CopyCopies image store content internally
/Resources/SecretsLists all the secret resources.
/Resources/VolumesLists all the volume resources.
/$/CancelRepairTaskRequests the cancellation of the given repair task.
/$/CreateRepairTaskCreates a new repair task.
/$/DeleteRepairTaskDeletes a completed repair task.
/$/GetClusterHealthGets the health of a Service Fabric cluster.
/$/GetClusterHealthGets the health of a Service Fabric cluster using the specified policy.
/ComposeDeploymentsGets the list of compose deployments created in the Service Fabric cluster.
/Resources/GatewaysLists all the gateway resources.
/Resources/NetworksLists all the network resources.
/Tools/Chaos/$/StopStops Chaos if it is running in the cluster and put the Chaos Schedule in a stopped state.
/Tools/Chaos/EventsGets the next segment of the Chaos events based on the continuation token or the time range.
/$/GetClusterVersionGet the current Service Fabric cluster version.
/$/GetRepairTaskListGets a list of repair tasks matching the given filters.
/Tools/Chaos/$/StartStarts Chaos in the cluster.
/$/GetClusterManifestGet the Service Fabric cluster manifest.
/$/GetLoadInformationGets the load of a Service Fabric cluster.
/$/GetUpgradeProgressGets the progress of the current cluster upgrade.
/Tools/Chaos/ScheduleGet the Chaos Schedule defining when and how to run Chaos.
/Tools/Chaos/ScheduleSet the schedule used by Chaos.
/$/ReportClusterHealthSends a health report on the Service Fabric cluster.
/Applications/$/CreateCreates a Service Fabric application.
/$/RecoverAllPartitionsIndicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss.
/Resources/ApplicationsLists all the application resources.
/$/GetClusterHealthChunkGets the health of a Service Fabric cluster using health chunks.
/$/GetClusterHealthChunkGets the health of a Service Fabric cluster using health chunks.
/ImageStore/$/FolderSizeGet the folder size at the root of the image store.
/$/ForceApproveRepairTaskForces the approval of the given repair task.
/EventsStore/Nodes/EventsGets all Nodes-related Events.
/ImageStore/{contentPath}Gets the image store content information.
/ImageStore/{contentPath}Uploads contents of the file to the image store.
/ImageStore/{contentPath}Deletes existing image store content.
/Partitions/{partitionId}Gets the information about a Service Fabric partition.
/$/GetClusterConfigurationGet the Service Fabric standalone cluster configuration.
/$/MoveToNextUpgradeDomainMake the cluster upgrade move on to the next upgrade domain.
/$/RecoverSystemPartitionsIndicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss.
/BackupRestore/$/GetBackupsGets the list of backups available for the specified backed up entity at the specified backup location.
/EventsStore/Cluster/EventsGets all Cluster-related events.
/Nodes/{nodeName}/$/RestartRestarts a Service Fabric cluster node.
/$/InvokeInfrastructureQueryInvokes a read-only query on the given infrastructure service instance.
/ComposeDeployments/$/CreateCreates a Service Fabric compose deployment.
/EventsStore/Services/EventsGets all Services-related events.
/Nodes/{nodeName}/$/ActivateActivate a Service Fabric cluster node that is currently deactivated.
/$/GetProvisionedCodeVersionsGets a list of fabric code versions that are provisioned in a Service Fabric cluster.
/$/UpdateRepairExecutionStateUpdates the execution state of a repair task.
/ApplicationTypes/$/ProvisionProvisions 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.
/Applications/{applicationId}Gets information about a Service Fabric application.
/BackupRestore/BackupPoliciesGets all the backup policies configured.
/Names/{nameId}/$/GetPropertyGets the specified Service Fabric property.
/Names/{nameId}/$/GetPropertyCreates or updates a Service Fabric property.
/Names/{nameId}/$/GetPropertyDeletes the specified Service Fabric property.
/Names/{nameId}/$/GetSubNamesEnumerates all the Service Fabric names under a given name.
/Nodes/{nodeName}/$/GetHealthGets the health of a Service Fabric node.
/Nodes/{nodeName}/$/GetHealthGets the health of a Service Fabric node, by using the specified health policy.
/$/InvokeInfrastructureCommandInvokes an administrative command on the given Infrastructure Service instance.
/EventsStore/Containers/EventsGets all Containers-related events.
/EventsStore/Partitions/EventsGets all Partitions-related events.
/ImageStore/$/GetUploadSessionGet the image store upload session by ID.
/Nodes/{nodeName}/$/DeactivateDeactivate a Service Fabric cluster node with the specified deactivation intent.
/Services/{serviceId}/$/DeleteDeletes an existing Service Fabric service.
/Services/{serviceId}/$/UpdateUpdates a Service Fabric service using the specified update description.
/$/GetProvisionedConfigVersionsGets a list of fabric config versions that are provisioned in a Service Fabric cluster.
/$/UpdateRepairTaskHealthPolicyUpdates the health policy of the given repair task.
/Names/{nameId}/$/GetPropertiesGets information on all Service Fabric properties under a given name.
/EventsStore/Applications/EventsGets all Applications-related events.
/Nodes/{nodeName}/$/ReportHealthSends a health report on the Service Fabric node.
/ImageStore/$/CommitUploadSessionCommit an image store upload session.
/ImageStore/$/DeleteUploadSessionCancels an image store upload session.
/Services/{serviceId}/$/GetHealthGets the health of the specified Service Fabric service.
/Services/{serviceId}/$/GetHealthGets the health of the specified Service Fabric service, by using the specified health policy.
/Partitions/{partitionId}/$/BackupTriggers backup of the partition's state.
/Services/{serviceId}/$/GetBackupsGets the list of backups available for every partition in this service.
/$/StartClusterConfigurationUpgradeStart upgrading the configuration of a Service Fabric standalone cluster.
/Nodes/{nodeName}/$/GetApplicationsGets the list of applications deployed on a Service Fabric node.
/Nodes/{nodeName}/$/RemoveNodeStateNotifies Service Fabric that the persisted state on a node has been permanently removed or lost.
/Partitions/{partitionId}/$/RecoverIndicates to the Service Fabric cluster that it should attempt to recover a specific partition that is currently stuck in quorum loss.
/Partitions/{partitionId}/$/RestoreTriggers restore of the state of the partition using the specified restore partition description.
/ComposeDeployments/{deploymentName}Gets information about a Service Fabric compose deployment.
/Services/{serviceId}/$/EnableBackupEnables periodic backup of stateful partitions under this Service Fabric service.
/Services/{serviceId}/$/ReportHealthSends a health report on the Service Fabric service.
/Services/{serviceId}/$/ResumeBackupResumes periodic backup of a Service Fabric service which was previously suspended.
/Partitions/{partitionId}/$/GetHealthGets the health of the specified Service Fabric partition.
/Partitions/{partitionId}/$/GetHealthGets the health of the specified Service Fabric partition, by using the specified health policy.
/Partitions/{partitionId}/$/ResetLoadResets the current load of a Service Fabric partition.
/Services/{serviceId}/$/DisableBackupDisables periodic backup of Service Fabric service which was previously enabled.
/Services/{serviceId}/$/GetPartitionsGets the list of partitions of a Service Fabric service.
/Services/{serviceId}/$/SuspendBackupSuspends periodic backup for the specified Service Fabric service.
/$/GetUpgradeOrchestrationServiceStateGet the service state of Service Fabric Upgrade Orchestration Service.
/$/SetUpgradeOrchestrationServiceStateUpdate the service state of Service Fabric Upgrade Orchestration Service.
/Applications/{applicationId}/$/DeleteDeletes an existing Service Fabric application.
/BackupRestore/BackupPolicies/$/CreateCreates a backup policy.
/EventsStore/Nodes/{nodeName}/$/EventsGets a Node-related events.
/ImageStore/{contentPath}/$/FolderSizeGet the size of a folder in image store
/Nodes/{nodeName}/$/GetLoadInformationGets the load information of a Service Fabric node.
/Partitions/{partitionId}/$/GetBackupsGets the list of backups available for the specified partition.
/Services/{serviceId}/$/GetDescriptionGets the description of an existing Service Fabric service.
/$/GetClusterConfigurationUpgradeStatusGet the cluster configuration upgrade status of a Service Fabric standalone cluster.
/ApplicationTypes/{applicationTypeName}Gets the list of application types in the Service Fabric cluster matching exactly the specified name.
/Applications/{applicationId}/$/UpgradeStarts upgrading an application in the Service Fabric cluster.
/ImageStore/{contentPath}/$/UploadChunkUploads a file chunk to the image store relative path.
/Partitions/{partitionId}/$/GetReplicasGets the information about replicas of a Service Fabric service partition.
/Resources/Secrets/{secretResourceName}Gets the Secret resource with the given name.
/Resources/Secrets/{secretResourceName}Creates or updates a Secret resource.
/Resources/Secrets/{secretResourceName}Deletes the Secret resource.
/Resources/Volumes/{volumeResourceName}Gets the Volume resource with the given name.
/Resources/Volumes/{volumeResourceName}Creates or updates a Volume resource.
/Resources/Volumes/{volumeResourceName}Deletes the Volume resource.
/Nodes/{nodeName}/$/DeployServicePackageDownloads all of the code packages associated with specified service manifest on the specified node.
/Partitions/{partitionId}/$/EnableBackupEnables periodic backup of the stateful persisted partition.
/Partitions/{partitionId}/$/ReportHealthSends a health report on the Service Fabric partition.
/Partitions/{partitionId}/$/ResumeBackupResumes periodic backup of partition which was previously suspended.
/Services/{serviceId}/$/ResolvePartitionResolve a Service Fabric partition.
/Applications/{applicationId}/$/GetHealthGets the health of the service fabric application.
/Applications/{applicationId}/$/GetHealthGets the health of a Service Fabric application using the specified policy.
/Partitions/{partitionId}/$/DisableBackupDisables periodic backup of Service Fabric partition which was previously enabled.
/Partitions/{partitionId}/$/SuspendBackupSuspends periodic backup for the specified partition.
/Resources/Gateways/{gatewayResourceName}Gets the Gateway resource with the given name.
/Resources/Gateways/{gatewayResourceName}Creates or updates a Gateway resource.
/Resources/Gateways/{gatewayResourceName}Deletes the Gateway resource.
/Resources/Networks/{networkResourceName}Gets the Network resource with the given name.
/Resources/Networks/{networkResourceName}Creates or updates a Network resource.
/Resources/Networks/{networkResourceName}Deletes the Network resource.
/Applications/{applicationId}/$/GetBackupsGets the list of backups available for every partition in this application.
/EventsStore/Services/{serviceId}/$/EventsGets a Service-related events.
/Partitions/{partitionId}/$/GetServiceNameGets the name of the Service Fabric service for a partition.
/Services/{serviceId}/$/GetApplicationNameGets the name of the Service Fabric application for a service.
/Applications/{applicationId}/$/GetServicesGets the information about all services belonging to the application specified by the application ID.
/Faults/Nodes/{nodeName}/$/StartTransition/Starts or stops a cluster node.
/Applications/{applicationId}/$/EnableBackupEnables periodic backup of stateful partitions under this Service Fabric application.
/Applications/{applicationId}/$/ReportHealthSends a health report on the Service Fabric application.
/Applications/{applicationId}/$/ResumeBackupResumes periodic backup of a Service Fabric application which was previously suspended.
/ImageStore/{contentPath}/$/GetUploadSessionGet the image store upload session by relative path.
/Applications/{applicationId}/$/DisableBackupDisables periodic backup of Service Fabric application.
/Applications/{applicationId}/$/SuspendBackupSuspends periodic backup for the specified Service Fabric application.
/Applications/{applicationId}/$/UpdateUpgradeUpdates an ongoing application upgrade in the Service Fabric cluster.
/ComposeDeployments/{deploymentName}/$/DeleteDeletes an existing Service Fabric compose deployment from cluster.
/Names/{nameId}/$/GetProperties/$/SubmitBatchSubmits a property batch.
/Partitions/{partitionId}/$/GetBackupProgressGets details for the latest backup triggered for this partition.
/ComposeDeployments/{deploymentName}/$/UpgradeStarts upgrading a compose deployment in the Service Fabric cluster.
/EventsStore/Partitions/{partitionId}/$/EventsGets a Partition-related events.
/Partitions/{partitionId}/$/GetLoadInformationGets the load information of the specified Service Fabric partition.
/Partitions/{partitionId}/$/GetRestoreProgressGets details for the latest restore operation triggered for this partition.
/Partitions/{partitionId}/$/MovePrimaryReplicaMoves the primary replica of a partition of a stateful service.
/Resources/Secrets/{secretResourceName}/valuesList names of all values of the specified secret resource.
/$/ToggleVerboseServicePlacementHealthReportingChanges the verbosity of service placement health reporting.
/Applications/{applicationId}/$/RollbackUpgradeStarts rolling back the currently on-going upgrade of an application in the Service Fabric cluster.
/BackupRestore/BackupPolicies/{backupPolicyName}Gets a particular backup policy by name.
/Faults/Nodes/{nodeName}/$/GetTransitionProgressGets the progress of an operation started using StartNodeTransition.
/Partitions/{partitionId}/$/MoveSecondaryReplicaMoves the secondary replica of a partition of a stateful service.
/Resources/Applications/{applicationResourceName}Gets the Application resource with the given name.
/Resources/Applications/{applicationResourceName}Creates or updates a Application resource.
/Resources/Applications/{applicationResourceName}Deletes the Application resource.
/Services/$/{serviceId}/$/GetPartitions/$/RecoverIndicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss.
/Applications/{applicationId}/$/GetLoadInformationGets load information about a Service Fabric application.
/Applications/{applicationId}/$/GetUpgradeProgressGets details for the latest upgrade performed on this application.
/EventsStore/Applications/{applicationId}/$/EventsGets an Application-related events.
/Services/{serviceId}/$/GetBackupConfigurationInfoGets the Service Fabric service backup configuration information.
/Nodes/{nodeName}/$/GetApplications/{applicationId}Gets the information about an application deployed on a Service Fabric node.
/Partitions/{partitionId}/$/GetReplicas/{replicaId}Gets the information about a replica of a Service Fabric partition.
/Applications/{applicationId}/$/GetServices/$/CreateCreates the specified Service Fabric service.
/ApplicationTypes/{applicationTypeName}/$/UnprovisionRemoves or unregisters a Service Fabric application type from the cluster.
/Services/{serviceId}/$/GetUnplacedReplicaInformationGets the information about unplaced replica of the service.
/ComposeDeployments/{deploymentName}/$/RollbackUpgradeStarts rolling back a compose deployment upgrade in the Service Fabric cluster.
/Partitions/{partitionId}/$/GetBackupConfigurationInfoGets the partition backup configuration information
/Applications/{applicationId}/$/GetServices/{serviceId}Gets the information about the specific service belonging to the Service Fabric application.
/Applications/{applicationId}/$/MoveToNextUpgradeDomainResumes upgrading an application in the Service Fabric cluster.
/EventsStore/Partitions/{partitionId}/$/Replicas/EventsGets all Replicas-related events for a Partition.
/EventsStore/CorrelatedEvents/{eventInstanceId}/$/EventsGets all correlated events for a given event.
/ApplicationTypes/{applicationTypeName}/$/GetServiceTypesGets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster.
/BackupRestore/BackupPolicies/{backupPolicyName}/$/DeleteDeletes the backup policy.
/BackupRestore/BackupPolicies/{backupPolicyName}/$/UpdateUpdates the backup policy.
/ComposeDeployments/{deploymentName}/$/GetUpgradeProgressGets details for the latest upgrade performed on this Service Fabric compose deployment.
/Applications/{applicationId}/$/GetBackupConfigurationInfoGets the Service Fabric application backup configuration information.
/Resources/Applications/{applicationResourceName}/ServicesLists all the service resources.
/ApplicationTypes/{applicationTypeName}/$/GetServiceManifestGets the manifest describing a service type.
/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicasGets the details of replica deployed on a Service Fabric node.
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealthGets the information about health of an application deployed on a Service Fabric node.
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealthGets the information about health of an application deployed on a Service Fabric node. using the specified policy.
/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealthGets the health of a Service Fabric stateful service replica or stateless service instance.
/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealthGets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy.
/ApplicationTypes/{applicationTypeName}/$/GetApplicationManifestGets the manifest describing an application type.
/Applications/{applicationId}/$/GetServices/$/CreateFromTemplateCreates a Service Fabric service from the service template.
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicasGets the list of replicas deployed on a Service Fabric node.
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/ReportHealthSends a health report on the Service Fabric application deployed on a Service Fabric node.
/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/ReportHealthSends a health report on the Service Fabric replica.
/EventsStore/Partitions/{partitionId}/$/Replicas/{replicaId}/$/EventsGets a Partition Replica-related events.
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackagesGets the list of code packages deployed on a Service Fabric node.
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypesGets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster.
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackagesGets the list of service packages deployed on a Service Fabric node.
/Resources/Secrets/{secretResourceName}/values/{secretValueResourceName}Gets the specified secret value resource.
/Resources/Secrets/{secretResourceName}/values/{secretValueResourceName}Adds the specified value as a new version of the specified secret resource.
/Resources/Secrets/{secretResourceName}/values/{secretValueResourceName}Deletes the specified value of the named secret resource.
/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartRestartThis API will restart some or all replicas or instances of the specified partition.
/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartDataLossThis API will induce data loss for the specified partition. It will trigger a call to the OnDataLossAsync API of the partition.
/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes/{serviceTypeName}Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster.
/BackupRestore/BackupPolicies/{backupPolicyName}/$/GetBackupEnabledEntitiesGets the list of backup entities that are associated with this policy.
/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartQuorumLossInduces quorum loss for a given stateful service partition.
/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetRestartProgressGets the progress of a PartitionRestart operation started using StartPartitionRestart.
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/RestartRestarts a code package deployed on a Service Fabric node in a cluster.
/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetDataLossProgressGets the progress of a partition data loss operation started using the StartDataLoss API.
/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}Gets the Service resource with the given name.
/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetQuorumLossProgressGets the progress of a quorum loss operation on a partition started using the StartQuorumLoss API.
/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/DeleteRemoves a service replica running on a node.
/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/RestartRestarts a service replica of a persisted service running on a node.
/Resources/Secrets/{secretResourceName}/values/{secretValueResourceName}/list_valueLists the specified value of the secret resource.
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerApiInvoke container API on a container deployed on a Service Fabric node.
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerLogsGets the container logs for container deployed on a Service Fabric node.
/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetDetailGets the details of replica deployed on a Service Fabric node.
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes/{serviceTypeName}Gets the information about a specified service type of the application deployed on a node in a Service Fabric cluster.
/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/ReplicasLists all the replicas of a service.
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}Gets the list of service packages deployed on a Service Fabric node matching exactly the specified name.
/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/Replicas/{replicaName}Gets the given replica of the service of an application.
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealthGets 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}/$/GetHealthGets 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}/$/ReportHealthSends a health report on the Service Fabric deployed service package.
/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/Replicas/{replicaName}/CodePackages/{codePackageName}/LogsGets the logs from the container.